Evals

Update an eval

Update certain properties of an evaluation.

post/evals/{eval_id}

Path parameters

eval_idstring required

The ID of the evaluation to update.

Request body

namestring

Rename the evaluation.

metadataMetadata nullable

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.

Response

The updated evaluation

object'eval' required

The object type.

idstring required

Unique identifier for the evaluation.

namestring required

The name of the evaluation.

created_atinteger required

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

metadataMetadata nullable required

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.

Changes

Changed in 6 of the 163 revisions of this API.5113

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ●

      added the new max enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property ///////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ////////// to the response with the status

      response-optional-property-added

    • ○

      the response's property default value eval was removed for the status

      response-property-default-value-removed

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

  • 74cbcf73838f53See the full diff
    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      response property data_source_config/oneOf[subschema #2: StoredCompletionsDataSourceConfig -> subschema #3: StoredCompletionsDataSourceConfig]/metadata list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property metadata list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      added to the / response property oneOf list for the response status

      response-property-one-of-added

    • ▲

      added to the response property oneOf list for the response status

      response-property-one-of-added

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      response property data_source_config/oneOf[subschema #2: StoredCompletionsDataSourceConfig -> subschema #3: StoredCompletionsDataSourceConfig]/ deprecated

      response-property-deprecated

    • ○

      removed from the / response property oneOf list for the response status

      response-property-one-of-removed

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

    • ○

      endpoint added

      endpoint-added

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