Skip to main content
Section ID: DOC-API-MODEL-schema-oi3nhojaso#overview

EvaluationPageInfo

One-based offset-pagination position, page size and result totals.

Meaning and usage​

Section ID: DOC-API-MODEL-schema-oi3nhojaso#meaning

See the definition above.

Usage profiles​

Section ID: DOC-API-MODEL-schema-oi3nhojaso#fields

UsageFields and validation
In responsesView fields

In responses​

Section ID: DOC-API-MODEL-schema-oi3nhojaso#response

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-oi3nhojaso#field-pageSection ID: DOC-API-MODEL-schema-oi3nhojaso#response-field-pagepagestring (int64)OptionalOne-based page number. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-oi3nhojaso#field-limitSection ID: DOC-API-MODEL-schema-oi3nhojaso#response-field-limitlimitstring (int64)OptionalMaximum number of entries requested from the listing. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-oi3nhojaso#field-totalitemsSection ID: DOC-API-MODEL-schema-oi3nhojaso#response-field-totalitemstotalItemsstring (int64)OptionalTotal item count reported for the current query. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-oi3nhojaso#field-totalpagesSection ID: DOC-API-MODEL-schema-oi3nhojaso#response-field-totalpagestotalPagesstring (int64)OptionalTotal number of pages reported for the current query. Pattern: ^-?\d+$.

Where used​

Section ID: DOC-API-MODEL-schema-oi3nhojaso#where-used

ReferenceRelationship
List annotation queue itemsPOST /api/v1/evals/list-annotation-queue-items
List annotation queuesPOST /api/v1/evals/list-annotation-queues
List commentsPOST /api/v1/evals/list-comments
List dataset itemsPOST /api/v1/evals/list-dataset-items
List datasetsPOST /api/v1/evals/list-datasets
List score configsPOST /api/v1/evals/list-score-configs

Download the public reference contract.

Document ID: DOC-API-MODEL-schema-oi3nhojaso