All Implemented Interfaces:


public final class RunCreateResponse

A schema representing an evaluation run.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`RunCreateResponse.Builder`	A builder for RunCreateResponse.
`public final class`	`RunCreateResponse.DataSource`	Information about the run's data source.
`public final class`	`RunCreateResponse.Metadata`	Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
`public final class`	`RunCreateResponse.PerModelUsage`
`public final class`	`RunCreateResponse.PerTestingCriteriaResult`
`public final class`	`RunCreateResponse.ResultCounts`	Counters summarizing the outcomes of the evaluation run.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`id()`	Unique identifier for the evaluation run.
`final Long`	`createdAt()`	Unix timestamp (in seconds) when the evaluation run was created.
`final RunCreateResponse.DataSource`	`dataSource()`	Information about the run's data source.
`final EvalApiError`	`error()`	An object representing an error response from the Eval API.
`final String`	`evalId()`	The identifier of the associated evaluation.
`final Optional<RunCreateResponse.Metadata>`	`metadata()`	Set of 16 key-value pairs that can be attached to an object.
`final String`	`model()`	The model that is evaluated, if applicable.
`final String`	`name()`	The name of the evaluation run.
`final JsonValue`	`_object_()`	The type of the object.
`final List<RunCreateResponse.PerModelUsage>`	`perModelUsage()`	Usage statistics for each model during the evaluation run.
`final List<RunCreateResponse.PerTestingCriteriaResult>`	`perTestingCriteriaResults()`	Results per testing criteria applied during the evaluation run.
`final String`	`reportUrl()`	The URL to the rendered evaluation run report on the UI dashboard.
`final RunCreateResponse.ResultCounts`	`resultCounts()`	Counters summarizing the outcomes of the evaluation run.
`final String`	`status()`	The status of the evaluation run.
`final JsonField<String>`	`_id()`	Returns the raw JSON value of id.
`final JsonField<Long>`	`_createdAt()`	Returns the raw JSON value of createdAt.
`final JsonField<RunCreateResponse.DataSource>`	`_dataSource()`	Returns the raw JSON value of dataSource.
`final JsonField<EvalApiError>`	`_error()`	Returns the raw JSON value of error.
`final JsonField<String>`	`_evalId()`	Returns the raw JSON value of evalId.
`final JsonField<RunCreateResponse.Metadata>`	`_metadata()`	Returns the raw JSON value of metadata.
`final JsonField<String>`	`_model()`	Returns the raw JSON value of model.
`final JsonField<String>`	`_name()`	Returns the raw JSON value of name.
`final JsonField<List<RunCreateResponse.PerModelUsage>>`	`_perModelUsage()`	Returns the raw JSON value of perModelUsage.
`final JsonField<List<RunCreateResponse.PerTestingCriteriaResult>>`	`_perTestingCriteriaResults()`	Returns the raw JSON value of perTestingCriteriaResults.
`final JsonField<String>`	`_reportUrl()`	Returns the raw JSON value of reportUrl.
`final JsonField<RunCreateResponse.ResultCounts>`	`_resultCounts()`	Returns the raw JSON value of resultCounts.
`final JsonField<String>`	`_status()`	Returns the raw JSON value of status.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final RunCreateResponse.Builder`	`toBuilder()`
`final RunCreateResponse`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static RunCreateResponse.Builder`	`builder()`	Returns a mutable builder for constructing an instance of RunCreateResponse.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
    Unique identifier for the evaluation run.
  - createdAt
```
 final Long createdAt()
```
    Unix timestamp (in seconds) when the evaluation run was created.
  - dataSource
```
 final RunCreateResponse.DataSource dataSource()
```
    Information about the run's data source.
  - error
```
 final EvalApiError error()
```
    An object representing an error response from the Eval API.
  - evalId
```
 final String evalId()
```
    The identifier of the associated evaluation.
  - metadata
```
 final Optional<RunCreateResponse.Metadata> metadata()
```
    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
    Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
  - model
```
 final String model()
```
    The model that is evaluated, if applicable.
  - name
```
 final String name()
```
    The name of the evaluation run.
  - _object_
```
 final JsonValue _object_()
```
    The type of the object. Always "eval.run".
    Expected to always return the following:
    JsonValue.from("eval.run")
    However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
  - perModelUsage
```
 final List<RunCreateResponse.PerModelUsage> perModelUsage()
```
    Usage statistics for each model during the evaluation run.
  - perTestingCriteriaResults
```
 final List<RunCreateResponse.PerTestingCriteriaResult> perTestingCriteriaResults()
```
    Results per testing criteria applied during the evaluation run.
  - reportUrl
```
 final String reportUrl()
```
    The URL to the rendered evaluation run report on the UI dashboard.
  - resultCounts
```
 final RunCreateResponse.ResultCounts resultCounts()
```
    Counters summarizing the outcomes of the evaluation run.
  - status
```
 final String status()
```
    The status of the evaluation run.
  - _id
```
 final JsonField<String> _id()
```
    Returns the raw JSON value of id.
    Unlike id, this method doesn't throw if the JSON field has an unexpected type.
  - _createdAt
```
 final JsonField<Long> _createdAt()
```
    Returns the raw JSON value of createdAt.
    Unlike createdAt, this method doesn't throw if the JSON field has an unexpected type.
  - _dataSource
```
 final JsonField<RunCreateResponse.DataSource> _dataSource()
```
    Returns the raw JSON value of dataSource.
    Unlike dataSource, this method doesn't throw if the JSON field has an unexpected type.
  - _error
```
 final JsonField<EvalApiError> _error()
```
    Returns the raw JSON value of error.
    Unlike error, this method doesn't throw if the JSON field has an unexpected type.
  - _evalId
```
 final JsonField<String> _evalId()
```
    Returns the raw JSON value of evalId.
    Unlike evalId, this method doesn't throw if the JSON field has an unexpected type.
  - _metadata
```
 final JsonField<RunCreateResponse.Metadata> _metadata()
```
    Returns the raw JSON value of metadata.
    Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
  - _model
```
 final JsonField<String> _model()
```
    Returns the raw JSON value of model.
    Unlike model, this method doesn't throw if the JSON field has an unexpected type.
  - _name
```
 final JsonField<String> _name()
```
    Returns the raw JSON value of name.
    Unlike name, this method doesn't throw if the JSON field has an unexpected type.
  - _perModelUsage
```
 final JsonField<List<RunCreateResponse.PerModelUsage>> _perModelUsage()
```
    Returns the raw JSON value of perModelUsage.
    Unlike perModelUsage, this method doesn't throw if the JSON field has an unexpected type.
  - _perTestingCriteriaResults
```
 final JsonField<List<RunCreateResponse.PerTestingCriteriaResult>> _perTestingCriteriaResults()
```
    Returns the raw JSON value of perTestingCriteriaResults.
    Unlike perTestingCriteriaResults, this method doesn't throw if the JSON field has an unexpected type.
  - _reportUrl
```
 final JsonField<String> _reportUrl()
```
    Returns the raw JSON value of reportUrl.
    Unlike reportUrl, this method doesn't throw if the JSON field has an unexpected type.
  - _resultCounts
```
 final JsonField<RunCreateResponse.ResultCounts> _resultCounts()
```
    Returns the raw JSON value of resultCounts.
    Unlike resultCounts, this method doesn't throw if the JSON field has an unexpected type.
  - _status
```
 final JsonField<String> _status()
```
    Returns the raw JSON value of status.
    Unlike status, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final RunCreateResponse.Builder toBuilder()
```
  - validate
```
 final RunCreateResponse validate()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static RunCreateResponse.Builder builder()
```
    Returns a mutable builder for constructing an instance of RunCreateResponse.
    The following fields are required:
    .id() .createdAt() .dataSource() .error() .evalId() .metadata() .model() .name() .perModelUsage() .perTestingCriteriaResults() .reportUrl() .resultCounts() .status()

Class RunCreateResponse

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

createdAt

dataSource

error

evalId

metadata

model

name

_object_

perModelUsage

perTestingCriteriaResults

reportUrl

resultCounts

status

_id

_createdAt

_dataSource

_error

_evalId

_metadata

_model

_name

_perModelUsage

_perTestingCriteriaResults

_reportUrl

_resultCounts

_status

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder