Class EvalRetrieveResponse
-
- All Implemented Interfaces:
public final class EvalRetrieveResponse
An Eval object with a data source config and testing criteria. An Eval represents a task to be done for your LLM integration. Like:
Improve the quality of my chatbot
See how well my chatbot handles customer support
Check if o4-mini is better at my usecase than gpt-4o
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
EvalRetrieveResponse.Builder
A builder for EvalRetrieveResponse.
public final class
EvalRetrieveResponse.DataSourceConfig
Configuration of data sources used in runs of the evaluation.
public final class
EvalRetrieveResponse.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
EvalRetrieveResponse.TestingCriterion
A LabelModelGrader object which uses a model to assign labels to each item in the evaluation.
-
Method Summary
Modifier and Type Method Description final String
id()
Unique identifier for the evaluation. final Long
createdAt()
The Unix timestamp (in seconds) for when the eval was created. final EvalRetrieveResponse.DataSourceConfig
dataSourceConfig()
Configuration of data sources used in runs of the evaluation. final Optional<EvalRetrieveResponse.Metadata>
metadata()
Set of 16 key-value pairs that can be attached to an object. final String
name()
The name of the evaluation. final JsonValue
_object_()
The object type. final List<EvalRetrieveResponse.TestingCriterion>
testingCriteria()
A list of testing criteria. final JsonField<String>
_id()
Returns the raw JSON value of id. final JsonField<Long>
_createdAt()
Returns the raw JSON value of createdAt. final JsonField<EvalRetrieveResponse.DataSourceConfig>
_dataSourceConfig()
Returns the raw JSON value of dataSourceConfig. final JsonField<EvalRetrieveResponse.Metadata>
_metadata()
Returns the raw JSON value of metadata. final JsonField<String>
_name()
Returns the raw JSON value of name. final JsonField<List<EvalRetrieveResponse.TestingCriterion>>
_testingCriteria()
Returns the raw JSON value of testingCriteria. final Map<String, JsonValue>
_additionalProperties()
final EvalRetrieveResponse.Builder
toBuilder()
final EvalRetrieveResponse
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static EvalRetrieveResponse.Builder
builder()
Returns a mutable builder for constructing an instance of EvalRetrieveResponse. -
-
Method Detail
-
dataSourceConfig
final EvalRetrieveResponse.DataSourceConfig dataSourceConfig()
Configuration of data sources used in runs of the evaluation.
-
metadata
final Optional<EvalRetrieveResponse.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 object type.
Expected to always return the following:
JsonValue.from("eval")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
testingCriteria
final List<EvalRetrieveResponse.TestingCriterion> testingCriteria()
A list of testing criteria.
-
_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.
-
_dataSourceConfig
final JsonField<EvalRetrieveResponse.DataSourceConfig> _dataSourceConfig()
Returns the raw JSON value of dataSourceConfig.
Unlike dataSourceConfig, this method doesn't throw if the JSON field has an unexpected type.
-
_metadata
final JsonField<EvalRetrieveResponse.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, 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.
-
_testingCriteria
final JsonField<List<EvalRetrieveResponse.TestingCriterion>> _testingCriteria()
Returns the raw JSON value of testingCriteria.
Unlike testingCriteria, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final EvalRetrieveResponse.Builder toBuilder()
-
validate
final EvalRetrieveResponse validate()
-
builder
final static EvalRetrieveResponse.Builder builder()
Returns a mutable builder for constructing an instance of EvalRetrieveResponse.
The following fields are required:
.id() .createdAt() .dataSourceConfig() .metadata() .name() .testingCriteria()
-
-
-
-