Get Evaluation

Retrieve an evaluation by ID

get/sdk/v1/evaluations/{id}

Path parameters

idstring required
Example:1212121

Response

Successful operation

idstring required
promptIdstring required
variablesPromptVariables required

The template variables added to the prompt when executing the prompt.

weightnumber

How heavily to weigh the evaluation within the prompt.

thresholdnumber

What percentage of assertions must pass for the evaluation to pass.

Changes

Changed in 3 of the 50 revisions of this API.36

  • 6c87a6d2f0a112See the full diff
    • added TextContentBlock to the appendedMessages/items/content/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • mapped value for discriminator key TEXT changed from TextContentBlockSchema to TextContentBlock for appendedMessages/items/content/items/ response property for the response status 200

      response-property-discriminator-mapping-changed

    • removed TextContentBlockSchema from the appendedMessages/items/content/items/ response property oneOf list for the response status 200

      response-property-one-of-removed

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

    • added TextContentBlockSchema to the appendedMessages/items/content/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • mapped value for discriminator key TEXT changed from TextContentBlock to TextContentBlockSchema for appendedMessages/items/content/items/ response property for the response status 200

      response-property-discriminator-mapping-changed

    • removed TextContentBlock from the appendedMessages/items/content/items/ response property oneOf list for the response status 200

      response-property-one-of-removed

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

    • added TextContentBlock to the appendedMessages/items/content/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • mapped value for discriminator key TEXT changed from TextContentBlockSchema to TextContentBlock for appendedMessages/items/content/items/ response property for the response status 200

      response-property-discriminator-mapping-changed

    • removed TextContentBlockSchema from the appendedMessages/items/content/items/ response property oneOf list for the response status 200

      response-property-one-of-removed

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