Class RunCreateParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class RunCreateParams implements Params
Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
RunCreateParams.Builder
A builder for RunCreateParams.
public final class
RunCreateParams.Body
public final class
RunCreateParams.DataSource
Details about the run's data source.
public final class
RunCreateParams.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.
-
Method Summary
Modifier and Type Method Description final Optional<String>
evalId()
final RunCreateParams.DataSource
dataSource()
Details about the run's data source. final Optional<RunCreateParams.Metadata>
metadata()
Set of 16 key-value pairs that can be attached to an object. final Optional<String>
name()
The name of the run. final JsonField<RunCreateParams.DataSource>
_dataSource()
Returns the raw JSON value of dataSource. final JsonField<RunCreateParams.Metadata>
_metadata()
Returns the raw JSON value of metadata. final JsonField<String>
_name()
Returns the raw JSON value of name. final Map<String, JsonValue>
_additionalBodyProperties()
final Headers
_additionalHeaders()
final QueryParams
_additionalQueryParams()
final RunCreateParams.Builder
toBuilder()
final RunCreateParams.Body
_body()
final String
_pathParam(Integer index)
Headers
_headers()
The full set of headers in the parameters, including both fixed and additional headers. QueryParams
_queryParams()
The full set of query params in the parameters, including both fixed and additional query params. Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static RunCreateParams.Builder
builder()
Returns a mutable builder for constructing an instance of RunCreateParams. -
-
Method Detail
-
dataSource
final RunCreateParams.DataSource dataSource()
Details about the run's data source.
-
metadata
final Optional<RunCreateParams.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.
-
_dataSource
final JsonField<RunCreateParams.DataSource> _dataSource()
Returns the raw JSON value of dataSource.
Unlike dataSource, this method doesn't throw if the JSON field has an unexpected type.
-
_metadata
final JsonField<RunCreateParams.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.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final RunCreateParams.Builder toBuilder()
-
_body
final RunCreateParams.Body _body()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static RunCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of RunCreateParams.
The following fields are required:
.dataSource()
-
-
-
-