Evaluation Set Endpoints

Create Evaluation Set Item

Evaluation set items are the individual files and expected outputs that are used to evaluate the performance of a given processor in Extend. This endpoint will create a new evaluation set item in Extend, which will be used during an evaluation run.

Best Practices for Outputs in Evaluation Sets:

  • Configure First, Output Later
    • Always create and finalize your processor configuration before creating evaluation sets
    • Field IDs in outputs must match those defined in your processor configuration
  • Type Consistency
    • Ensure output types exactly match your processor configuration
    • For example, if a field is configured as “currency”, don’t submit a simple number value
  • Field IDs
    • Use the exact field IDs from your processor configuration
    • Create your own semantic IDs instead in the configs for each field/type instead of using the generated ones
  • Value
    • Remember that all results are inside the value key of a result object, except the values within nested structures.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-extend-api-versionenumOptional

API version to use for the request. If you do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.

Allowed values:

Request

This endpoint expects an object.
evaluationSetIdstringRequired

The ID of the evaluation set to add the item to.

Example: "ev_Xj8mK2pL9nR4vT7qY5wZ"

fileIdstringRequired

Extend’s internal ID for the file. It will always start with “file_”.

Example: "file_xK9mLPqRtN3vS8wF5hB2cQ"

expectedOutputobject or map from strings to objects or objectRequired
The expected output that will be used to evaluate the processor's performance.

Response

Successfully created evaluation set item
successboolean
evaluationSetItemobject
The EvaluationSetItem object represents an item in an evaluation set in Extend. Items are the individual files and expected outputs that are used to evaluate the performance of a given processor in Extend.

Errors