Ejento APIs

Create Evaluation Test

POST

/evaltest/all/{agent_id}

Evaluation APIs

Creates a new evaluation test for the specified agent using the provided dataset ID.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/evaltest/all/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dataset_id": 9
}'

Response Example

{
    "success": true,
    "message": "Evaluation created successfully.",
    "data": {
        "id": 5,
        "created_by": "user@example.com",
        "created_on": "2024-10-22T19:59:47.758221Z",
        "modified_by": "",
        "modified_on": "2024-10-22T19:59:47.758273Z",
        "answer_similarity": null,
        "answer_relevancy": null,
        "faithfulness": null,
        "context_recall": null,
        "query_result": [],
        "status": "Pending",
        "agent": 3,
        "evaluation_dataset_id": 9
    }
}

Request

Path Params

agent_id

integer

required

The unique identifier of the agent.

Example:

Body Params application/json

dataset_id

integer

optional

The ID of the dataset to use for the evaluation.

Example:

Examples

Responses

🟢200OK

application/json

Evaluation created successfully.

Body

success

boolean

optional

Example:

true

message

string

optional

Example:

Evaluation created successfully.

data

object

optional

integer

optional

Example:

created_by

string

optional

Example:

user@example.com

created_on

string <date-time>

optional

Example:

2024-10-22T19:59:47.758221Z

modified_by

string

optional

Example:

modified_on

string <date-time>

optional

Example:

2024-10-22T19:59:47.758273Z

answer_similarity

number | null

optional

Example:

null

answer_relevancy

number | null

optional

Example:

null

faithfulness

number | null

optional

Example:

null

context_recall

number | null

optional

Example:

null

query_result

array [object]

optional

Example:

[]

status

string

optional

Example:

Pending

agent

integer

optional

Example:

evaluation_dataset_id

integer

optional

Example:

🟠400Bad Request

🟠401Unauthorized

Check Duplicate Documents

Get All Evaluation Tests for an Agent