Sign in
Eval Reports

Create Eval Run Suite Report

Create a summary for a suite of eval runs.

post/v2/eval-reports

Query parameters

workspace_uuidstring

Request body

eval_run_uuidsstring[] required

List of eval run UUIDs to include in the suite summary.

Response

OK

eval_suite_report_uuidstring required

Unique identifier for the eval suite report.

status'created' | 'processing' | 'finished' | 'failed' required

Resource status.

overall_improvement_advicestring nullable

Overall advice for improving future responses, if any.

overall_failing_responses_summarystring nullable

Overall summary of failing responses, if any.

overall_passing_responses_summarystring nullable

Overall summary of passing responses, if any.

created_atstring date-time required

Timestamp when the eval suite report was created.

updated_atstring date-time required

Timestamp when the eval suite report was last updated.

remaining_reportsinteger nullable

Number of remaining reports to be generated, if any.

Changes

Changed in 13 of the 25 revisions of this API.51228

  • 0cb64ef11adf2See the full diff
    • ▲

      removed the required property eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ai_instructions/anyOf[subschema #2: AgentInstructions]/tools/oneOf[subschema #1: ToolArray]/value/items/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ai_instructions/anyOf[subschema #3: WorkflowInstructions]/instructions/items/tools/oneOf[subschema #1: ToolArray]/value/items/id from the response with the 200 status

      response-required-property-removed

  • cd49adceebf82See the full diff
    • ○

      added subschema #1 subschema #4 to the eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ai_instructions response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed subschema #1 subschema #4 from the eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ai_instructions response property anyOf list for the response status 200

      response-property-any-of-removed

  • 0b43b7bedf322See the full diff
    • ○

      added the optional property eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ai_instructions/anyOf[subschema #2: AgentInstructions]/agent_name to the response with the 200 status

      response-optional-property-added

    • ○

      added WorkflowInstructions to the eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ai_instructions response property anyOf list for the response status 200

      response-property-any-of-added

  • 1af31c95d91a12See the full diff
    • ▲

      added ToolArray ToolDict ToolString to the eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ai_instructions/anyOf[subschema #2: AgentInstructions]/tools response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      removed ToolsList ToolDict ToolsString from the eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ai_instructions/anyOf[subschema #2: AgentInstructions]/tools response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      added discriminator to eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ai_instructions/anyOf[subschema #2: AgentInstructions]/tools response property for the response status 200

      response-property-discriminator-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d950d722e2302See the full diff
    • ○

      added subschema #1 subschema #3 to the eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ai_instructions/anyOf[subschema #2: AgentInstructions]/tools response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed subschema #1 subschema #3 from the eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ai_instructions/anyOf[subschema #2: AgentInstructions]/tools response property anyOf list for the response status 200

      response-property-any-of-removed

  • 9f42371cf19a4See the full diff
    • ○

      added the optional property eval_run_reports/items/eval_run/responses/anyOf[subschema #1]/items/manually_updated to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property eval_run_reports/items/eval_run/responses/anyOf[subschema #1]/items/manually_updated_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property eval_run_reports/items/eval_run/responses/anyOf[subschema #1]/items/manually_updated_by to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property eval_run_reports/items/eval_run/responses/anyOf[subschema #1]/items/update_history to the response with the 200 status

      response-optional-property-added

  • 33b4b8e9d2ce2See the full diff
    • ○

      added subschema #1 to the eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ai_instructions/anyOf[subschema #2: AgentInstructions]/tools response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed subschema #2 from the eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ai_instructions/anyOf[subschema #2: AgentInstructions]/tools response property anyOf list for the response status 200

      response-property-any-of-removed

  • b824d75fc3cb1See the full diff
    • ○

      added AgentInstructions to the eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ai_instructions response property anyOf list for the response status 200

      response-property-any-of-added

  • 9b529d67a7d0125See the full diff
    • ●

      deleted the query request parameter is_sandbox

      request-parameter-removed

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 422

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 503

      response-property-enum-value-added

    • ●

      added the new video enum value to the eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/modality/allOf[subschema #1: ContentType]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new video enum value to the eval_run_reports/items/eval_run/responses/anyOf[subschema #1]/items/content_type/allOf[subschema #1: ContentType]/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property eval_run_reports/items/eval_run/eval_run_examples to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/created_by to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/ground_truth/anyOf[subschema #2: FileReference]/file_uuid to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property eval_run_reports/items/eval_run/is_sandbox to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property eval_run_reports/items/eval_run/responses/anyOf[subschema #1]/items/content/anyOf[subschema #2: FileReference]/file_uuid to the response with the 200 status

      response-optional-property-added

  • 39873621da545See the full diff
    • ○

      the num_prompts response's property default value changed from 50 to 100 for the status 200

      response-property-default-value-changed

    • ○

      removed the audio enum value from the eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/modality/allOf[subschema #1: ContentType]/ response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the audio enum value from the eval_run_reports/items/eval_run/responses/anyOf[subschema #1]/items/content_type/allOf[subschema #1: ContentType]/ response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the video enum value from the eval_run_reports/items/eval_run/evaluation/anyOf[subschema #1: Eval]/modality/allOf[subschema #1: ContentType]/ response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the video enum value from the eval_run_reports/items/eval_run/responses/anyOf[subschema #1]/items/content_type/allOf[subschema #1: ContentType]/ response property for the response status 200

      response-property-enum-value-removed