Get all versions, the active version and thresholds

curl --request GET \
  --url https://api.brussle.com/v1/namespaces/{ns}/judgments/{name} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.brussle.com/v1/namespaces/{ns}/judgments/{name}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.brussle.com/v1/namespaces/{ns}/judgments/{name}', 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.brussle.com/v1/namespaces/{ns}/judgments/{name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.brussle.com/v1/namespaces/{ns}/judgments/{name}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.brussle.com/v1/namespaces/{ns}/judgments/{name}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "name": "<string>",
  "active_version": 2,
  "freshness": {
    "policy": "on_read",
    "debounce_ms": 0,
    "interval": "<string>",
    "max_wait_ms": 2,
    "fanout": {
      "scope": {
        "created_within": "<string>",
        "where": {}
      },
      "debounce_ms": 600000,
      "max_wait_ms": 2,
      "rolling_limit": 300000,
      "block_cap": 1000
    }
  },
  "thresholds": {},
  "outcomes": {
    "rules": [
      {
        "when": {
          "path": "attributes.status",
          "becomes": "<string>",
          "in": [
            "<string>"
          ]
        },
        "value": true,
        "on": "attributes.status",
        "from": "attributes.status"
      }
    ],
    "implicit_negatives": false
  },
  "versions": [
    {
      "version": 2,
      "created_at": "2023-11-07T05:31:56Z",
      "definition": {
        "name": "<string>",
        "question": "<string>",
        "type": "bool",
        "criteria": "<string>",
        "context": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "engine": {
          "name": "jev",
          "version": "<string>"
        },
        "horizon": "0s",
        "applies_to": {},
        "thresholds": {},
        "parts": [
          {
            "name": "<string>",
            "question": "<string>"
          }
        ],
        "features": [
          "<string>"
        ]
      }
    }
  ],
  "template": "<string>",
  "overrides": [
    "thresholds"
  ],
  "fanout_sources": {
    "scope": {
      "created_within": "judgment",
      "where": "judgment"
    },
    "debounce_ms": "judgment",
    "max_wait_ms": "judgment",
    "rolling_limit": "judgment",
    "block_cap": "judgment"
  },
  "fanout_window": {
    "used": 1,
    "rolls_at": "2023-11-07T05:31:56Z"
  },
  "escape_alert": 0.5,
  "warnings": [
    {
      "code": "taxonomy_drift",
      "message": "<string>",
      "escape_share": 0.5,
      "since": "2023-11-07T05:31:56Z"
    }
  ],
  "readers": [
    "<string>"
  ],
  "stats": {
    "day": "2023-12-25",
    "evaluations": 1,
    "spend_usd": 1,
    "tokens_per_document": 1,
    "truncation_rate": 0.5,
    "error_rate": 0.5,
    "freshness_lag_p90_ms": 1
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

GET

namespaces

{ns}

judgments

{name}

Get all versions, the active version and thresholds

curl --request GET \
  --url https://api.brussle.com/v1/namespaces/{ns}/judgments/{name} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.brussle.com/v1/namespaces/{ns}/judgments/{name}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.brussle.com/v1/namespaces/{ns}/judgments/{name}', 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.brussle.com/v1/namespaces/{ns}/judgments/{name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.brussle.com/v1/namespaces/{ns}/judgments/{name}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.brussle.com/v1/namespaces/{ns}/judgments/{name}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "name": "<string>",
  "active_version": 2,
  "freshness": {
    "policy": "on_read",
    "debounce_ms": 0,
    "interval": "<string>",
    "max_wait_ms": 2,
    "fanout": {
      "scope": {
        "created_within": "<string>",
        "where": {}
      },
      "debounce_ms": 600000,
      "max_wait_ms": 2,
      "rolling_limit": 300000,
      "block_cap": 1000
    }
  },
  "thresholds": {},
  "outcomes": {
    "rules": [
      {
        "when": {
          "path": "attributes.status",
          "becomes": "<string>",
          "in": [
            "<string>"
          ]
        },
        "value": true,
        "on": "attributes.status",
        "from": "attributes.status"
      }
    ],
    "implicit_negatives": false
  },
  "versions": [
    {
      "version": 2,
      "created_at": "2023-11-07T05:31:56Z",
      "definition": {
        "name": "<string>",
        "question": "<string>",
        "type": "bool",
        "criteria": "<string>",
        "context": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "engine": {
          "name": "jev",
          "version": "<string>"
        },
        "horizon": "0s",
        "applies_to": {},
        "thresholds": {},
        "parts": [
          {
            "name": "<string>",
            "question": "<string>"
          }
        ],
        "features": [
          "<string>"
        ]
      }
    }
  ],
  "template": "<string>",
  "overrides": [
    "thresholds"
  ],
  "fanout_sources": {
    "scope": {
      "created_within": "judgment",
      "where": "judgment"
    },
    "debounce_ms": "judgment",
    "max_wait_ms": "judgment",
    "rolling_limit": "judgment",
    "block_cap": "judgment"
  },
  "fanout_window": {
    "used": 1,
    "rolls_at": "2023-11-07T05:31:56Z"
  },
  "escape_alert": 0.5,
  "warnings": [
    {
      "code": "taxonomy_drift",
      "message": "<string>",
      "escape_share": 0.5,
      "since": "2023-11-07T05:31:56Z"
    }
  ],
  "readers": [
    "<string>"
  ],
  "stats": {
    "day": "2023-12-25",
    "evaluations": 1,
    "spend_usd": 1,
    "tokens_per_document": 1,
    "truncation_rate": 0.5,
    "error_rate": 0.5,
    "freshness_lag_p90_ms": 1
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {
      "reason": "<string>",
      "suggested_context": {
        "recipe": {
          "fields": [
            "<string>"
          ],
          "last_n": {},
          "window": {},
          "max_tokens": 2,
          "related": {},
          "previous": {
            "fields": [
              "<string>"
            ],
            "anchor": "<string>"
          }
        },
        "cost_per_answer": 1,
        "whole_state_cost_per_answer": 1,
        "sampled_documents": 2,
        "excluded": [
          {
            "path": "<string>",
            "reason": "id"
          }
        ]
      }
    }
  }
}

Authorizations

Authorization

string

header

required

An organization API key. Keys carry a role (read_write or read_only) and may be restricted to a namespace prefix such as acme/*, or to one namespace such as acme/prod/tenant_1. A prefix matches on a / boundary: acme/prod/tenant_1* covers acme/prod/tenant_1 and everything under acme/prod/tenant_1/, never acme/prod/tenant_12.

Path Parameters

string

required

A namespace name, or a template prefix ending in /*, with any / sent as %2F: acme%2Fprod%2Ftenant_123 or acme%2Fprod%2F*.

A namespace name, or a template prefix: a namespace path ending in /*, such as acme/prod/*, which every namespace under acme/prod/ inherits judgments from. Up to 256 bytes. Never exactly . or .., which a URL path can't carry.

Required string length: 1 - 256

Pattern: ^(?!\.\.?$)[A-Za-z0-9._:/-]+(/\*)?$

name

string

required

A judgment, attribute or threshold name. Names are path segments in field references, so they never contain ..

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9_-]+$

Response

The judgment.

name

string

required

A judgment, attribute or threshold name. Names are path segments in field references, so they never contain ..

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9_-]+$

active_version

integer<int32> | null

required

Null once the judgment is deactivated.

Required range: x >= 1

freshness

object

required

Settings, not part of the definition. Changing them creates no version.

Show child attributes

thresholds

object

required

The judgment's named thresholds, a setting rather than part of a version. Each is a number for a bool judgment (true when p is at least it) or a score judgment (true when score is at least it), and {value, gte} for a choice judgment (true when dist[value] is at least gte). They are evaluated at read time against the raw fields, never the calibrated ones. A threshold that does not fit the judgment's type is invalid_request.

Show child attributes

outcomes

object

required

How the judgment's outcomes are read and derived, a setting rather than part of a version. See calibration.

Show child attributes

versions

object[]

required

Every version, oldest first. Versions are kept until the namespace is deleted.

Show child attributes

template

string

Present when the judgment is inherited, the template prefix it comes from, such as acme/prod/*.

Required string length: 1 - 256

Pattern: ^(?!\.\.?$)[A-Za-z0-9._:/-]+(/\*)?$

overrides

enum<string>[]

Present when the judgment is inherited. The settings this namespace overrides; the others follow the template.

Available options:

thresholds,

freshness

fanout_sources

object

Where each value in freshness.fanout comes from, key for key. Present exactly when freshness.fanout is. A where removed with null is the default, no filter; any other null the judgment set, such as created_within: null, is the judgment's.

Show child attributes

fanout_window

object

Response only. How much of freshness.fanout.rolling_limit the judgment's fan-outs have used: the re-judgments counted in the rolling 30-day window. Present exactly when freshness.fanout is. A fan-out that would take used past the limit is deferred.

Show child attributes

escape_alert

number | null

A setting of a fixed-option choice: when the share of its answers over the last 7 days that are none_of_the_above rises above this, the judgment gains the taxonomy_drift warning and the events feed one judgment.taxonomy_drift. Null (the default) turns it off. Nothing changes on its own: run discover when you want proposals.

Required range: 0 < x <= 1

warnings

object[]

Conditions to act on, such as taxonomy_drift. Absent when there are none.

Show child attributes

readers

string[]

The judgments whose relations read this one's answers. While there are any, deleting or deactivating it, a policy other than on_change, or a version that is not plain or narrows applies_to below a reader's match is conflict naming them. Absent when there are none.

A judgment, attribute or threshold name. Names are path segments in field references, so they never contain ..

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9_-]+$

stats

object

Today's evaluations of the judgment in this namespace, UTC. The dashboard's per-judgment numbers. Before the day's first evaluation only day, evaluations (0) and spend_usd (0) are present.

Show child attributes

Namespaces

Documents

Judgments

Outcomes and calibration

Groups

Subscriptions

Jobs

Engines

Organization

Webhooks

Get all versions, the active version and thresholds

Authorizations

Path Parameters

Response