Constructor Detail

Method Detail

• id

   final RunRetrieveResponse.Builder id(String id)

  Unique identifier for the evaluation run.

• id

   final RunRetrieveResponse.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 RunRetrieveResponse.Builder createdAt(Long createdAt)

  Unix timestamp (in seconds) when the evaluation run was created.

• createdAt

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

• dataSource

   final RunRetrieveResponse.Builder dataSource(RunRetrieveResponse.DataSource dataSource)

  Information about the run's data source.

• dataSource

   final RunRetrieveResponse.Builder dataSource(JsonField<RunRetrieveResponse.DataSource> dataSource)

  Sets Builder.dataSource to an arbitrary JSON value.

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

• dataSource

   final RunRetrieveResponse.Builder dataSource(CreateEvalJsonlRunDataSource jsonl)

  Alias for calling dataSource with DataSource.ofJsonl(jsonl).

• dataSource

   final RunRetrieveResponse.Builder dataSource(CreateEvalCompletionsRunDataSource completions)

  Alias for calling dataSource with DataSource.ofCompletions(completions).

• jsonlDataSource

   final RunRetrieveResponse.Builder jsonlDataSource(CreateEvalJsonlRunDataSource.Source source)

  Alias for calling dataSource with the following:

  CreateEvalJsonlRunDataSource.builder()
      .source(source)
      .build()

• jsonlDataSource

   final RunRetrieveResponse.Builder jsonlDataSource(CreateEvalJsonlRunDataSource.Source.FileContent fileContent)

  Alias for calling jsonlDataSource with CreateEvalJsonlRunDataSource.Source.ofFileContent(fileContent).

• jsonlDataSource

   final RunRetrieveResponse.Builder jsonlDataSource(CreateEvalJsonlRunDataSource.Source.FileId fileId)

  Alias for calling jsonlDataSource with CreateEvalJsonlRunDataSource.Source.ofFileId(fileId).

• fileContentJsonlDataSource

   final RunRetrieveResponse.Builder fileContentJsonlDataSource(List<CreateEvalJsonlRunDataSource.Source.FileContent.Content> content)

  Alias for calling jsonlDataSource with the following:

  CreateEvalJsonlRunDataSource.Source.FileContent.builder()
      .content(content)
      .build()

• fileIdJsonlDataSource

   final RunRetrieveResponse.Builder fileIdJsonlDataSource(String id)

  Alias for calling jsonlDataSource with the following:

  CreateEvalJsonlRunDataSource.Source.FileId.builder()
      .id(id)
      .build()

• error

   final RunRetrieveResponse.Builder error(EvalApiError error)

  An object representing an error response from the Eval API.

• error

   final RunRetrieveResponse.Builder error(JsonField<EvalApiError> error)

  Sets Builder.error to an arbitrary JSON value.

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

• evalId

   final RunRetrieveResponse.Builder evalId(String evalId)

  The identifier of the associated evaluation.

• evalId

   final RunRetrieveResponse.Builder evalId(JsonField<String> evalId)

  Sets Builder.evalId to an arbitrary JSON value.

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

• metadata

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

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

• metadata

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

• model

   final RunRetrieveResponse.Builder model(String model)

  The model that is evaluated, if applicable.

• model

   final RunRetrieveResponse.Builder model(JsonField<String> model)

  Sets Builder.model to an arbitrary JSON value.

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

• name

   final RunRetrieveResponse.Builder name(String name)

  The name of the evaluation run.

• name

   final RunRetrieveResponse.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 RunRetrieveResponse.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.run")

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

• perModelUsage

   final RunRetrieveResponse.Builder perModelUsage(List<RunRetrieveResponse.PerModelUsage> perModelUsage)

  Usage statistics for each model during the evaluation run.

• perModelUsage

   final RunRetrieveResponse.Builder perModelUsage(JsonField<List<RunRetrieveResponse.PerModelUsage>> perModelUsage)

  Sets Builder.perModelUsage to an arbitrary JSON value.

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

• addPerModelUsage

   final RunRetrieveResponse.Builder addPerModelUsage(RunRetrieveResponse.PerModelUsage perModelUsage)

  Adds a single PerModelUsage to Builder.perModelUsage.

• perTestingCriteriaResults

   final RunRetrieveResponse.Builder perTestingCriteriaResults(List<RunRetrieveResponse.PerTestingCriteriaResult> perTestingCriteriaResults)

  Results per testing criteria applied during the evaluation run.

• perTestingCriteriaResults

   final RunRetrieveResponse.Builder perTestingCriteriaResults(JsonField<List<RunRetrieveResponse.PerTestingCriteriaResult>> perTestingCriteriaResults)

  Sets Builder.perTestingCriteriaResults to an arbitrary JSON value.

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

• addPerTestingCriteriaResult

   final RunRetrieveResponse.Builder addPerTestingCriteriaResult(RunRetrieveResponse.PerTestingCriteriaResult perTestingCriteriaResult)

  Adds a single PerTestingCriteriaResult to perTestingCriteriaResults.

• reportUrl

   final RunRetrieveResponse.Builder reportUrl(String reportUrl)

  The URL to the rendered evaluation run report on the UI dashboard.

• reportUrl

   final RunRetrieveResponse.Builder reportUrl(JsonField<String> reportUrl)

  Sets Builder.reportUrl to an arbitrary JSON value.

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

• resultCounts

   final RunRetrieveResponse.Builder resultCounts(RunRetrieveResponse.ResultCounts resultCounts)

  Counters summarizing the outcomes of the evaluation run.

• resultCounts

   final RunRetrieveResponse.Builder resultCounts(JsonField<RunRetrieveResponse.ResultCounts> resultCounts)

  Sets Builder.resultCounts to an arbitrary JSON value.

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

• status

   final RunRetrieveResponse.Builder status(String status)

  The status of the evaluation run.

• status

   final RunRetrieveResponse.Builder status(JsonField<String> status)

  Sets Builder.status to an arbitrary JSON value.

  You should usually call Builder.status 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 RunRetrieveResponse.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

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

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final RunRetrieveResponse.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

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

• build

   final RunRetrieveResponse build()

  Returns an immutable instance of RunRetrieveResponse.

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

  The following fields are required:

  .id()
  .createdAt()
  .dataSource()
  .error()
  .evalId()
  .metadata()
  .model()
  .name()
  .perModelUsage()
  .perTestingCriteriaResults()
  .reportUrl()
  .resultCounts()
  .status()