> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agents.kolena.com/llms.txt
> Use this file to discover all available pages before exploring further.

# kolena_agents.types.ground_truth

## `GroundTruth`

GroundTruth

### `id`

```python theme={null}
id: StrictInt
```

The unique ID of the Ground Truth.

### `version`

```python theme={null}
version: StrictInt
```

The current version number of the Ground Truth.

### `name`

```python theme={null}
name: StrictStr
```

The name of the Ground Truth.

### `evaluation_instructions`

```python theme={null}
evaluation_instructions: StrictStr
```

Instructions used to evaluate Runs against this Ground Truth.

### `runs`

```python theme={null}
runs: List[GroundTruthRun]
```

The list of Runs that make up this Ground Truth.

## `GroundTruthRun`

GroundTruthRun

### `user_defined_id`

```python theme={null}
user_defined_id: StrictStr
```

An user defined unique identifier attached to this Run.

### `data`

```python theme={null}
data: Dict[str, Any]
```

Mapping of Prompt name to value.

## `Validation`

Validation

### `id`

```python theme={null}
id: StrictInt
```

The unique ID of the validation.

### `ground_truth_id`

```python theme={null}
ground_truth_id: StrictInt
```

The ID of the Ground Truth this validation ran against.

### `ground_truth_version`

```python theme={null}
ground_truth_version: StrictInt
```

The version of the Ground Truth this validation ran against.

### `status`

```python theme={null}
status: ValidationStatus
```

The current status of the validation.

### `results`

```python theme={null}
results: Optional[ValidationResults] = None
```

## `ValidationResults`

ValidationResults

### `score`

```python theme={null}
score: Union[StrictFloat, StrictInt]
```

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`

```python theme={null}
RUNNING = 'running'
```

### `SUCCESS`

```python theme={null}
SUCCESS = 'success'
```

### `FAILED`

```python theme={null}
FAILED = 'failed'
```

### `CANCELED`

```python theme={null}
CANCELED = 'canceled'
```

## `CreateGroundTruthRequest`

CreateGroundTruthRequest

### `name`

```python theme={null}
name: str
```

### `evaluation_instructions`

```python theme={null}
evaluation_instructions: StrictStr
```

Instructions used to evaluate Runs against this Ground Truth.

### `runs`

```python theme={null}
runs: List[GroundTruthRun]
```

The list of Runs that make up this Ground Truth.

## `CreateGroundTruthVersionRequest`

CreateGroundTruthVersionRequest

### `evaluation_instructions`

```python theme={null}
evaluation_instructions: StrictStr
```

Instructions used to evaluate Runs against this Ground Truth.

### `runs`

```python theme={null}
runs: List[GroundTruthRun]
```

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

## `ListGroundTruthsResponse`

ListGroundTruthsResponse

### `ground_truths`

```python theme={null}
ground_truths: List[GroundTruth]
```

The list of Ground Truths.

### `total_pages`

```python theme={null}
total_pages: StrictInt
```

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`

```python theme={null}
page_number: Optional[Annotated[int, Field(strict=True, ge=0)]] = 0
```

The number of the fetched page.

### `page_size`

```python theme={null}
page_size: Optional[Annotated[int, Field(le=1000, strict=True)]] = 50
```

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

## `ListGroundTruthVersionsResponse`

ListGroundTruthVersionsResponse

### `versions`

```python theme={null}
versions: List[GroundTruth]
```

The list of Ground Truth versions.

### `total_pages`

```python theme={null}
total_pages: StrictInt
```

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`

```python theme={null}
page_number: Optional[Annotated[int, Field(strict=True, ge=0)]] = 0
```

The number of the fetched page.

### `page_size`

```python theme={null}
page_size: Optional[Annotated[int, Field(le=1000, strict=True)]] = 50
```

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

## `ListValidationsResponse`

ListValidationsResponse

### `validations`

```python theme={null}
validations: List[Validation]
```

The list of Validations.

### `total_pages`

```python theme={null}
total_pages: StrictInt
```

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

### `page_number`

```python theme={null}
page_number: Optional[Annotated[int, Field(strict=True, ge=0)]] = 0
```

The number of the fetched page.

### `page_size`

```python theme={null}
page_size: Optional[Annotated[int, Field(le=1000, strict=True)]] = 50
```

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

## `CreateValidationResponse`

CreateValidationResponse

### `validation_id`

```python theme={null}
validation_id: StrictInt
```

The ID of the created validation.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.