Class RunRetrieveResponse
-
- All Implemented Interfaces:
public final class RunRetrieveResponse
A schema representing an evaluation run.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
RunRetrieveResponse.Builder
A builder for RunRetrieveResponse.
public final class
RunRetrieveResponse.DataSource
Information about the run's data source.
public final class
RunRetrieveResponse.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
RunRetrieveResponse.PerModelUsage
public final class
RunRetrieveResponse.PerTestingCriteriaResult
public final class
RunRetrieveResponse.ResultCounts
Counters summarizing the outcomes of the evaluation run.
-
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 RunRetrieveResponse.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<RunRetrieveResponse.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<RunRetrieveResponse.PerModelUsage>
perModelUsage()
Usage statistics for each model during the evaluation run. final List<RunRetrieveResponse.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 RunRetrieveResponse.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<RunRetrieveResponse.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<RunRetrieveResponse.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<RunRetrieveResponse.PerModelUsage>>
_perModelUsage()
Returns the raw JSON value of perModelUsage. final JsonField<List<RunRetrieveResponse.PerTestingCriteriaResult>>
_perTestingCriteriaResults()
Returns the raw JSON value of perTestingCriteriaResults. final JsonField<String>
_reportUrl()
Returns the raw JSON value of reportUrl. final JsonField<RunRetrieveResponse.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 RunRetrieveResponse.Builder
toBuilder()
final RunRetrieveResponse
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static RunRetrieveResponse.Builder
builder()
Returns a mutable builder for constructing an instance of RunRetrieveResponse. -
-
Method Detail
-
dataSource
final RunRetrieveResponse.DataSource dataSource()
Information about the run's data source.
-
error
final EvalApiError error()
An object representing an error response from the Eval API.
-
metadata
final Optional<RunRetrieveResponse.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.
-
_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<RunRetrieveResponse.PerModelUsage> perModelUsage()
Usage statistics for each model during the evaluation run.
-
perTestingCriteriaResults
final List<RunRetrieveResponse.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 RunRetrieveResponse.ResultCounts resultCounts()
Counters summarizing the outcomes 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<RunRetrieveResponse.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<RunRetrieveResponse.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<RunRetrieveResponse.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<RunRetrieveResponse.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<RunRetrieveResponse.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 RunRetrieveResponse.Builder toBuilder()
-
validate
final RunRetrieveResponse validate()
-
builder
final static RunRetrieveResponse.Builder builder()
Returns a mutable builder for constructing an instance of RunRetrieveResponse.
The following fields are required:
.id() .createdAt() .dataSource() .error() .evalId() .metadata() .model() .name() .perModelUsage() .perTestingCriteriaResults() .reportUrl() .resultCounts() .status()
-
-
-
-