Constructor Detail

Method Detail

• dataSourceConfig

   final EvalCreateParams.Body.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.Body.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.Body.Builder dataSourceConfig(EvalCreateParams.DataSourceConfig.Custom custom)

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

• dataSourceConfig

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

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

• dataSourceConfig

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

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

• customDataSourceConfig

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

  Alias for calling dataSourceConfig with the following:

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

• testingCriteria

   final EvalCreateParams.Body.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.Body.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.Body.Builder addTestingCriterion(EvalCreateParams.TestingCriterion testingCriterion)

  Adds a single TestingCriterion to testingCriteria.

• addTestingCriterion

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

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

• addTestingCriterion

   final EvalCreateParams.Body.Builder addTestingCriterion(StringCheckGrader stringCheck)

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

• addTestingCriterion

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

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

• addTestingCriterion

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

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

• addTestingCriterion

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

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

• metadata

   final EvalCreateParams.Body.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.Body.Builder metadata(Optional<EvalCreateParams.Metadata> metadata)

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

• metadata

   final EvalCreateParams.Body.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.Body.Builder name(String name)

  The name of the evaluation.

• name

   final EvalCreateParams.Body.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.

• additionalProperties

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

• putAdditionalProperty

   final EvalCreateParams.Body.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final EvalCreateParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final EvalCreateParams.Body.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final EvalCreateParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final EvalCreateParams.Body build()

  Returns an immutable instance of Body.

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

  The following fields are required:

  .dataSourceConfig()
  .testingCriteria()