Skip to main content

GroundTruth

GroundTruth

id

The unique ID of the Ground Truth.

version

The current version number of the Ground Truth.

name

The name of the Ground Truth.

evaluation_instructions

Instructions used to evaluate Runs against this Ground Truth.

runs

The list of Runs that make up this Ground Truth.

GroundTruthRun

GroundTruthRun

user_defined_id

An user defined unique identifier attached to this Run.

data

Mapping of Prompt name to value.

Validation

Validation

id

The unique ID of the validation.

ground_truth_id

The ID of the Ground Truth this validation ran against.

ground_truth_version

The version of the Ground Truth this validation ran against.

status

The current status of the validation.

results

ValidationResults

ValidationResults

score

The aggregate matching score of the validation, expressed as a percentage: the number of fields matching the Ground Truth divided by the number of fields compared. Fields excluded by the evaluation instructions are skipped and count towards neither.

ValidationStatus

ValidationStatus

RUNNING

SUCCESS

FAILED

CANCELED

CreateGroundTruthRequest

CreateGroundTruthRequest

name

evaluation_instructions

Instructions used to evaluate Runs against this Ground Truth.

runs

The list of Runs that make up this Ground Truth.

CreateGroundTruthVersionRequest

CreateGroundTruthVersionRequest

evaluation_instructions

Instructions used to evaluate Runs against this Ground Truth.

runs

The list of Runs that make up this Ground Truth version.

ListGroundTruthsResponse

ListGroundTruthsResponse

ground_truths

The list of Ground Truths.

total_pages

The total number of pages of Ground Truths. Use the request arguments page_number and page_size to control which Ground Truths are fetched.

page_number

The number of the fetched page.

page_size

The page size, i.e. number of Ground Truths, fetched.

ListGroundTruthVersionsResponse

ListGroundTruthVersionsResponse

versions

The list of Ground Truth versions.

total_pages

The total number of pages of Ground Truth versions. Use the request arguments page_number and page_size to control which Ground Truth versions are fetched.

page_number

The number of the fetched page.

page_size

The page size, i.e. number of Ground Truth versions, fetched.

ListValidationsResponse

ListValidationsResponse

validations

The list of Validations.

total_pages

The total number of pages of Validations. Use the request arguments page_number and page_size to control which Validations are fetched.

page_number

The number of the fetched page.

page_size

The page size, i.e. number of Validations, fetched.

CreateValidationResponse

CreateValidationResponse

validation_id

The ID of the created validation.