Constructor Detail

Method Detail

• body

   final EvalCreateParams.Builder body(EvalCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • dataSourceConfig

  • testingCriteria

  • metadata

  • name

• dataSourceConfig

   final EvalCreateParams.Builder dataSourceConfig(EvalCreateParams.DataSourceConfig dataSourceConfig)

  The configuration for the data source used for the evaluation runs. Dictates the schema of the data used in the evaluation.

• dataSourceConfig

   final EvalCreateParams.Builder dataSourceConfig(JsonField<EvalCreateParams.DataSourceConfig> dataSourceConfig)

  Sets Builder.dataSourceConfig to an arbitrary JSON value.

  You should usually call Builder.dataSourceConfig with a well-typed DataSourceConfig value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• dataSourceConfig

   final EvalCreateParams.Builder dataSourceConfig(EvalCreateParams.DataSourceConfig.Custom custom)

  Alias for calling dataSourceConfig with DataSourceConfig.ofCustom(custom).

• dataSourceConfig

   final EvalCreateParams.Builder dataSourceConfig(EvalCreateParams.DataSourceConfig.Logs logs)

  Alias for calling dataSourceConfig with DataSourceConfig.ofLogs(logs).

• dataSourceConfig

  @Deprecated(message = "deprecated") final EvalCreateParams.Builder dataSourceConfig(EvalCreateParams.DataSourceConfig.StoredCompletions storedCompletions)

  Alias for calling dataSourceConfig with DataSourceConfig.ofStoredCompletions(storedCompletions).

• customDataSourceConfig

   final EvalCreateParams.Builder customDataSourceConfig(EvalCreateParams.DataSourceConfig.Custom.ItemSchema itemSchema)

  Alias for calling dataSourceConfig with the following:

  DataSourceConfig.Custom.builder()
      .itemSchema(itemSchema)
      .build()

• testingCriteria

   final EvalCreateParams.Builder testingCriteria(List<EvalCreateParams.TestingCriterion> testingCriteria)

  A list of graders for all eval runs in this group. Graders can reference variables in the data source using double curly braces notation, like {{item.variable_name}}. To reference the model's output, use the sample namespace (ie, {{sample.output_text}}).

• testingCriteria

   final EvalCreateParams.Builder testingCriteria(JsonField<List<EvalCreateParams.TestingCriterion>> testingCriteria)

  Sets Builder.testingCriteria to an arbitrary JSON value.

  You should usually call Builder.testingCriteria with a well-typed List<TestingCriterion> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addTestingCriterion

   final EvalCreateParams.Builder addTestingCriterion(EvalCreateParams.TestingCriterion testingCriterion)

  Adds a single TestingCriterion to testingCriteria.

• addTestingCriterion

   final EvalCreateParams.Builder addTestingCriterion(EvalCreateParams.TestingCriterion.LabelModel labelModel)

  Alias for calling addTestingCriterion with TestingCriterion.ofLabelModel(labelModel).

• addTestingCriterion

   final EvalCreateParams.Builder addTestingCriterion(StringCheckGrader stringCheck)

  Alias for calling addTestingCriterion with TestingCriterion.ofStringCheck(stringCheck).

• addTestingCriterion

   final EvalCreateParams.Builder addTestingCriterion(EvalCreateParams.TestingCriterion.TextSimilarity textSimilarity)

  Alias for calling addTestingCriterion with TestingCriterion.ofTextSimilarity(textSimilarity).

• addTestingCriterion

   final EvalCreateParams.Builder addTestingCriterion(EvalCreateParams.TestingCriterion.Python python)

  Alias for calling addTestingCriterion with TestingCriterion.ofPython(python).

• addTestingCriterion

   final EvalCreateParams.Builder addTestingCriterion(EvalCreateParams.TestingCriterion.ScoreModel scoreModel)

  Alias for calling addTestingCriterion with TestingCriterion.ofScoreModel(scoreModel).

• metadata

   final EvalCreateParams.Builder metadata(EvalCreateParams.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.

• metadata

   final EvalCreateParams.Builder metadata(Optional<EvalCreateParams.Metadata> metadata)

  Alias for calling Builder.metadata with metadata.orElse(null).

• metadata

   final EvalCreateParams.Builder metadata(JsonField<EvalCreateParams.Metadata> metadata)

  Sets Builder.metadata to an arbitrary JSON value.

  You should usually call Builder.metadata with a well-typed Metadata value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• name

   final EvalCreateParams.Builder name(String name)

  The name of the evaluation.

• name

   final EvalCreateParams.Builder name(JsonField<String> name)

  Sets Builder.name to an arbitrary JSON value.

  You should usually call Builder.name with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final EvalCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final EvalCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final EvalCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final EvalCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final EvalCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final EvalCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final EvalCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final EvalCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final EvalCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final EvalCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final EvalCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final EvalCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final EvalCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final EvalCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final EvalCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final EvalCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final EvalCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final EvalCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final EvalCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final EvalCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final EvalCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final EvalCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final EvalCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final EvalCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final EvalCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final EvalCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final EvalCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final EvalCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final EvalCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final EvalCreateParams build()

  Returns an immutable instance of EvalCreateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .dataSourceConfig()
  .testingCriteria()