=encoding utf8

=head1 NAME

OpenAPI::Client::OpenAI::Path::evals-eval_id - Documentation for the /evals/{eval_id} path.

=head1 OPERATIONS

=head2 DELETE /evals/{eval_id}

=head3 deleteEval

  $client->delete_eval({
      body => { ... },
  });

Delete an evaluation.

=head4 Path/query parameters

=over

=item * C<eval_id> (in path, required, string) - The ID of the evaluation to delete.

=back

=head4 Responses

B<200 - Successfully deleted the evaluation.>

Content-Type: application/json

Properties:

=over

=item * C<deleted> (boolean, required)

=item * C<eval_id> (string, required)

=item * C<object> (string, required)

=back

Example:

    {
       "deleted" : true,
       "eval_id" : "eval_abc123",
       "object" : "eval.deleted"
    }

B<404 - Evaluation not found.>

Content-Type: application/json

Example:

    {
       "code" : "string",
       "message" : "string",
       "param" : "string",
       "type" : "string"
    }

=head2 GET /evals/{eval_id}

=head3 getEval

  $client->get_eval({
      body => { ... },
  });

Get an evaluation by ID.

=head4 Path/query parameters

=over

=item * C<eval_id> (in path, required, string) - The ID of the evaluation to retrieve.

=back

=head4 Responses

B<200 - The evaluation>

Content-Type: application/json

Example:

    "{\n  \"object\": \"eval\",\n  \"id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n  \"data_source_config\": {\n    \"type\": \"custom\",\n    \"item_schema\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"label\": {\"type\": \"string\"},\n      },\n      \"required\": [\"label\"]\n    },\n    \"include_sample_schema\": true\n  },\n  \"testing_criteria\": [\n    {\n      \"name\": \"My string check grader\",\n      \"type\": \"string_check\",\n      \"input\": \"{{sample.output_text}}\",\n      \"reference\": \"{{item.label}}\",\n      \"operation\": \"eq\",\n    }\n  ],\n  \"name\": \"External Data Eval\",\n  \"created_at\": 1739314509,\n  \"metadata\": {\n    \"test\": \"synthetics\",\n  }\n}\n"

=head2 POST /evals/{eval_id}

=head3 updateEval

  $client->update_eval({
      body => { ... },
  });

Update certain properties of an evaluation.

=head4 Path/query parameters

=over

=item * C<eval_id> (in path, required, string) - The ID of the evaluation to update.

=back

=head4 Request body

Content-Type: application/json

Properties:

=over

=item * C<metadata> (Metadata)

See L</Metadata> below for shape.

=item * C<name> (string) - Rename the evaluation.

=back

Example:

    {
       "metadata" : {},
       "name" : "string"
    }

=head4 Responses

B<200 - The updated evaluation>

Content-Type: application/json

Example:

    "{\n  \"object\": \"eval\",\n  \"id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n  \"data_source_config\": {\n    \"type\": \"custom\",\n    \"item_schema\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"label\": {\"type\": \"string\"},\n      },\n      \"required\": [\"label\"]\n    },\n    \"include_sample_schema\": true\n  },\n  \"testing_criteria\": [\n    {\n      \"name\": \"My string check grader\",\n      \"type\": \"string_check\",\n      \"input\": \"{{sample.output_text}}\",\n      \"reference\": \"{{item.label}}\",\n      \"operation\": \"eq\",\n    }\n  ],\n  \"name\": \"External Data Eval\",\n  \"created_at\": 1739314509,\n  \"metadata\": {\n    \"test\": \"synthetics\",\n  }\n}\n"

=head1 SCHEMAS

=head2 Error

Properties:

=over

=item * C<code> (anyOf, required)

=item * C<message> (string, required)

=item * C<param> (anyOf, required)

=item * C<type> (string, required)

=back

=head2 Eval

Properties:

=over

=item * C<created_at> (integer, required) - The Unix timestamp (in seconds) for when the eval was created.

=item * C<data_source_config> (object, required) - Configuration of data sources used in runs of the evaluation.

=item * C<id> (string, required) - Unique identifier for the evaluation.

=item * C<metadata> (Metadata, required)

See L</Metadata> below for shape.

=item * C<name> (string, required) - The name of the evaluation.

=item * C<object> (string, required) - The object type.

Allowed values: eval

Default: eval

=item * C<testing_criteria> (array of object, required) - A list of testing criteria.

Default: eval

=back

=head2 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.

=head1 SEE ALSO

L<OpenAPI::Client::OpenAI::Path>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2023-2026 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.14.0 or,
at your option, any later version of Perl 5 you may have available.

=cut
