Constructor Detail

Method Detail

• id

   final EvalCreateResponse.Builder id(String id)

  Unique identifier for the evaluation.

• id

   final EvalCreateResponse.Builder id(JsonField<String> id)

  Sets Builder.id to an arbitrary JSON value.

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

• createdAt

   final EvalCreateResponse.Builder createdAt(Long createdAt)

  The Unix timestamp (in seconds) for when the eval was created.

• createdAt

   final EvalCreateResponse.Builder createdAt(JsonField<Long> createdAt)

  Sets Builder.createdAt to an arbitrary JSON value.

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

• dataSourceConfig

   final EvalCreateResponse.Builder dataSourceConfig(EvalCreateResponse.DataSourceConfig dataSourceConfig)

  Configuration of data sources used in runs of the evaluation.

• dataSourceConfig

   final EvalCreateResponse.Builder dataSourceConfig(JsonField<EvalCreateResponse.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 EvalCreateResponse.Builder dataSourceConfig(EvalCustomDataSourceConfig custom)

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

• dataSourceConfig

   final EvalCreateResponse.Builder dataSourceConfig(EvalStoredCompletionsDataSourceConfig storedCompletions)

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

• customDataSourceConfig

   final EvalCreateResponse.Builder customDataSourceConfig(EvalCustomDataSourceConfig.Schema schema)

  Alias for calling dataSourceConfig with the following:

  EvalCustomDataSourceConfig.builder()
      .schema(schema)
      .build()

• storedCompletionsDataSourceConfig

   final EvalCreateResponse.Builder storedCompletionsDataSourceConfig(EvalStoredCompletionsDataSourceConfig.Schema schema)

  Alias for calling dataSourceConfig with the following:

  EvalStoredCompletionsDataSourceConfig.builder()
      .schema(schema)
      .build()

• metadata

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

• metadata

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

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

• metadata

   final EvalCreateResponse.Builder metadata(JsonField<EvalCreateResponse.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 EvalCreateResponse.Builder name(String name)

  The name of the evaluation.

• name

   final EvalCreateResponse.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.

• object_

   final EvalCreateResponse.Builder object_(JsonValue object_)

  Sets the field to an arbitrary JSON value.

  It is usually unnecessary to call this method because the field defaults to the following:

  JsonValue.from("eval")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• shareWithOpenAI

   final EvalCreateResponse.Builder shareWithOpenAI(Boolean shareWithOpenAI)

  Indicates whether the evaluation is shared with OpenAI.

• shareWithOpenAI

   final EvalCreateResponse.Builder shareWithOpenAI(JsonField<Boolean> shareWithOpenAI)

  Sets Builder.shareWithOpenAI to an arbitrary JSON value.

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

• testingCriteria

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

  A list of testing criteria.

• testingCriteria

   final EvalCreateResponse.Builder testingCriteria(JsonField<List<EvalCreateResponse.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 EvalCreateResponse.Builder addTestingCriterion(EvalCreateResponse.TestingCriterion testingCriterion)

  Adds a single TestingCriterion to testingCriteria.

• addTestingCriterion

   final EvalCreateResponse.Builder addTestingCriterion(EvalLabelModelGrader labelModel)

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

• addTestingCriterion

   final EvalCreateResponse.Builder addTestingCriterion(EvalStringCheckGrader stringCheck)

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

• addTestingCriterion

   final EvalCreateResponse.Builder addTestingCriterion(EvalTextSimilarityGrader textSimilarity)

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

• additionalProperties

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

• putAdditionalProperty

   final EvalCreateResponse.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final EvalCreateResponse.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final EvalCreateResponse.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final EvalCreateResponse build()

  Returns an immutable instance of EvalCreateResponse.

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

  The following fields are required:

  .id()
  .createdAt()
  .dataSourceConfig()
  .metadata()
  .name()
  .shareWithOpenAI()
  .testingCriteria()