Class EvalCreateResponse
-
- All Implemented Interfaces:
public final class EvalCreateResponse
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 o3-mini is better at my usecase than gpt-4o
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
EvalCreateResponse.Builder
A builder for EvalCreateResponse.
public final class
EvalCreateResponse.DataSourceConfig
Configuration of data sources used in runs of the evaluation.
public final class
EvalCreateResponse.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
EvalCreateResponse.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 EvalCreateResponse.DataSourceConfig
dataSourceConfig()
Configuration of data sources used in runs of the evaluation. final Optional<EvalCreateResponse.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 Boolean
shareWithOpenAI()
Indicates whether the evaluation is shared with OpenAI. final List<EvalCreateResponse.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<EvalCreateResponse.DataSourceConfig>
_dataSourceConfig()
Returns the raw JSON value of dataSourceConfig. final JsonField<EvalCreateResponse.Metadata>
_metadata()
Returns the raw JSON value of metadata. final JsonField<String>
_name()
Returns the raw JSON value of name. final JsonField<Boolean>
_shareWithOpenAI()
Returns the raw JSON value of shareWithOpenAI. final JsonField<List<EvalCreateResponse.TestingCriterion>>
_testingCriteria()
Returns the raw JSON value of testingCriteria. final Map<String, JsonValue>
_additionalProperties()
final EvalCreateResponse.Builder
toBuilder()
final EvalCreateResponse
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static EvalCreateResponse.Builder
builder()
Returns a mutable builder for constructing an instance of EvalCreateResponse. -
-
Method Detail
-
dataSourceConfig
final EvalCreateResponse.DataSourceConfig dataSourceConfig()
Configuration of data sources used in runs of the evaluation.
-
metadata
final Optional<EvalCreateResponse.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).
-
shareWithOpenAI
final Boolean shareWithOpenAI()
Indicates whether the evaluation is shared with OpenAI.
-
testingCriteria
final List<EvalCreateResponse.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<EvalCreateResponse.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<EvalCreateResponse.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.
-
_shareWithOpenAI
final JsonField<Boolean> _shareWithOpenAI()
Returns the raw JSON value of shareWithOpenAI.
Unlike shareWithOpenAI, this method doesn't throw if the JSON field has an unexpected type.
-
_testingCriteria
final JsonField<List<EvalCreateResponse.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 EvalCreateResponse.Builder toBuilder()
-
validate
final EvalCreateResponse validate()
-
builder
final static EvalCreateResponse.Builder builder()
Returns a mutable builder for constructing an instance of EvalCreateResponse.
The following fields are required:
.id() .createdAt() .dataSourceConfig() .metadata() .name() .shareWithOpenAI() .testingCriteria()
-
-
-
-