DOC-API-MODEL-schema-ovg7lvels1#overview
EvalFilter
Typed comparison operand and column selector for querying evaluation-provider records.
The filter type selects which single value field is meaningful.
Input constraints
Section ID: DOC-API-MODEL-schema-ovg7lvels1#input-constraints
type
Section ID: DOC-API-MODEL-schema-ovg7lvels1#type
Select a listed comparison type.
Meaning and usage
Section ID: DOC-API-MODEL-schema-ovg7lvels1#meaning
See the definition above.
Input constraints
Section ID: DOC-API-MODEL-schema-ovg7lvels1#input-constraints-1
See the definition above.
type
Section ID: DOC-API-MODEL-schema-ovg7lvels1#type-1
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-ovg7lvels1#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
In requests
Section ID: DOC-API-MODEL-schema-ovg7lvels1#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-ovg7lvels1#field-typeSection ID: DOC-API-MODEL-schema-ovg7lvels1#request-field-typetype | string (EVAL_FILTER_TYPE_DATETIME, EVAL_FILTER_TYPE_STRING, EVAL_FILTER_TYPE_NUMBER, EVAL_FILTER_TYPE_STRING_OPTIONS, EVAL_FILTER_TYPE_CATEGORY_OPTIONS, EVAL_FILTER_TYPE_ARRAY_OPTIONS, EVAL_FILTER_TYPE_BOOLEAN, EVAL_FILTER_TYPE_NULL, EVAL_FILTER_TYPE_STRING_OBJECT, EVAL_FILTER_TYPE_NUMBER_OBJECT, EVAL_FILTER_TYPE_BOOLEAN_OBJECT) or integer (int32) (0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10) | Required in requests | Discriminator selecting the evaluation filter’s operand type. |
Section ID: DOC-API-MODEL-schema-ovg7lvels1#field-columnSection ID: DOC-API-MODEL-schema-ovg7lvels1#request-field-columncolumn | string | Required in requests | Evaluation filter column identifier, for example traceName, scores_avg, metadata or level. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-ovg7lvels1#field-operatorSection ID: DOC-API-MODEL-schema-ovg7lvels1#request-field-operatoroperator | string | Required in requests | Operator accepted for the selected filter type, for example contains, any of or >=. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-ovg7lvels1#field-keySection ID: DOC-API-MODEL-schema-ovg7lvels1#request-field-keykey | string | Optional | Set only for the *_OBJECT types: the metadata key or score name. |
Section ID: DOC-API-MODEL-schema-ovg7lvels1#field-stringvalueSection ID: DOC-API-MODEL-schema-ovg7lvels1#request-field-stringvaluestringValue | string | Optional | Text operand used by a text-valued evaluation filter. |
Section ID: DOC-API-MODEL-schema-ovg7lvels1#field-numbervalueSection ID: DOC-API-MODEL-schema-ovg7lvels1#request-field-numbervaluenumberValue | number (double) or string (NaN, Infinity, -Infinity) | Optional | Numeric operand used by the evaluation filter. |
Section ID: DOC-API-MODEL-schema-ovg7lvels1#field-booleanvalueSection ID: DOC-API-MODEL-schema-ovg7lvels1#request-field-booleanvaluebooleanValue | boolean | Optional | Boolean operand used by the selected evaluation filter type. |
Section ID: DOC-API-MODEL-schema-ovg7lvels1#field-stringvaluesSection ID: DOC-API-MODEL-schema-ovg7lvels1#request-field-stringvaluesstringValues | Array of string | Optional | Text values used by the *_OPTIONS comparison types. |
Section ID: DOC-API-MODEL-schema-ovg7lvels1#field-timevalueSection ID: DOC-API-MODEL-schema-ovg7lvels1#request-field-timevaluetimeValue | string (date-time) | Optional | Timestamp operand used by the evaluation filter. |
Values of type
Section ID: DOC-API-MODEL-schema-ovg7lvels1#request-values-type
Operand shape and comparison vocabulary for an evaluation-record filter. Types and operators follow the provider's v3.224.1 filter vocabulary, including keyed object variants.
| Value | No. | Form | Meaning |
|---|---|---|---|
EVAL_FILTER_TYPE_DATETIME | 0 | Canonical | See meaning below. |
EVAL_FILTER_TYPE_STRING | 1 | Canonical | See meaning below. |
EVAL_FILTER_TYPE_NUMBER | 2 | Canonical | See meaning below. |
EVAL_FILTER_TYPE_STRING_OPTIONS | 3 | Canonical | See meaning below. |
EVAL_FILTER_TYPE_CATEGORY_OPTIONS | 4 | Canonical | See meaning below. |
EVAL_FILTER_TYPE_ARRAY_OPTIONS | 5 | Canonical | See meaning below. |
EVAL_FILTER_TYPE_BOOLEAN | 6 | Canonical | See meaning below. |
EVAL_FILTER_TYPE_NULL | 7 | Canonical | See meaning below. |
EVAL_FILTER_TYPE_STRING_OBJECT | 8 | Canonical | Compare a string-valued member identified by a key, such as a metadata property. STRING_OBJECT supports metadata filtering; NUMBER_OBJECT and BOOLEAN_OBJECT support score filtering keyed by score name. |
EVAL_FILTER_TYPE_NUMBER_OBJECT | 9 | Canonical | Compare a numeric member identified by a key, such as a named score. |
EVAL_FILTER_TYPE_BOOLEAN_OBJECT | 10 | Canonical | Compare a boolean member identified by a key. |
EVAL_FILTER_TYPE_DATETIME
Compare a date-time value using ordered comparisons.
> < >= <=
EVAL_FILTER_TYPE_STRING
Compare text using equality or supported substring and prefix or suffix operators.
= contains does not contain starts with ends with
EVAL_FILTER_TYPE_NUMBER
Compare a numeric value using equality or ordered comparisons.
= > < >= <=
EVAL_FILTER_TYPE_STRING_OPTIONS
Match a string against a set of allowed or excluded choices.
any of none of
EVAL_FILTER_TYPE_CATEGORY_OPTIONS
Match a category against a set of allowed or excluded choices.
any of none of
EVAL_FILTER_TYPE_ARRAY_OPTIONS
Match array contents using any-of, none-of or all-of selection.
any of none of all of
EVAL_FILTER_TYPE_BOOLEAN
Compare a boolean value for equality or inequality.
= <>
EVAL_FILTER_TYPE_NULL
Test whether the selected property is null or non-null.
is null is not null
DOC-API-MODEL-schema-ovg7lvels1#validation
Request validation
Section ID: DOC-API-MODEL-schema-ovg7lvels1#request-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
type | Required value | true |
type | Defined enum value | true |
column | Minimum length | 1 |
operator | Minimum length | 1 |
Where used
Section ID: DOC-API-MODEL-schema-ovg7lvels1#where-used
| Reference | Relationship |
|---|---|
| List observations | POST /api/v1/evals/list-observations |
| List scores | POST /api/v1/evals/list-scores |
| List sessions | POST /api/v1/evals/list-sessions |
| List traces | POST /api/v1/evals/list-traces |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-ovg7lvels1