Ejento APIs
V1
  • V2
  • V1
  1. Evaluation APIs
Ejento APIs
V1
  • V2
  • V1
  • Overview
  • Endpoints
    • Chat APIs
      • Run Chat
      • Create Custom Instructions
      • Add Comment Feedback
      • Add Upvote Feedback
      • Add Downvote Feedback
      • Get Chat Thread
      • Get Thought Process
      • Get Supporting Content
      • Get All Agent Threads
    • Agent APIs
      • Get Recent Agents
      • Add to Recent Agents
      • Delete Recent Agent
      • Get Starred Agents
      • Delete Starred Agents
      • Get Agents by Team or User Team
      • Create a Review for an Agent
      • Get Agent Reviews
      • Update an Agent Review
      • Delete an Agent Review
      • Create Agent Chat
      • Get Agent Ratings
      • Toggle Rating
      • Create Agent Alias
      • Get All Agent Alias
      • Update Agent Alias
      • Get Agent Access Level
      • Update Agent Access Level
      • Get All Agents by Project
      • Get Agent Types
      • Update Agent Type
      • Get User Agent or User Agent Permission
    • Project APIs
      • Create New Project
      • Get All Projects
      • Get Project Details by ID
      • Edit Project By ID
      • Delete Project By ID
      • Add Recent Project
      • Get Recent Projects
      • Fetch Project Details
      • Add User to Project
      • Remove User from Project
      • Get User Projects For Team
    • Document APIs
      • Get Document By ID
      • Edit Document By ID
      • Delete Document By ID
    • Corpus APIs
      • Get All Corpus
      • Create Corpus
      • Get Corpus by ID
      • Edit Corpus
      • Delete Corpus
      • Get Corpus Permissions
      • Create Corpus Permissions
      • Delete Corpus Permissions
      • Get Corpus Permission By User
      • Create Document In Corpus
      • Get All Documents From Corpus
      • Delete All Documents
      • Check Duplicate Documents
    • Evaluation APIs
      • Create Evaluation Test
        POST
      • Get All Evaluation Tests for an Agent
        GET
      • Update Evaluation Test
        PUT
      • Get One Evaluation Test
        GET
      • Update Evaluation Status
        PUT
      • Get Evaluation Dataset for an Agent
        GET
      • Get All Evaluation Datasets for an Agent
        GET
      • Create Evaluation Dataset
        POST
      • Update Evaluation Dataset
        PUT
      • Delete Evaluation Dataset
        DELETE
      • Get Agent Queries
        GET
      • Get Dataset Queries
        GET
    • SharePoint APIs
      • Get SharePoint items by full path
      • Get a SharePoint item by its ID
      • Create a new SharePoint item
      • Edit SharePoint item
      • Delete a SharePoint item
    • User APIs
      • Get All Users
      • Get User By ID
      • Edit User By ID
      • Delete User by ID
      • Create User Permission
      • Get User Permission by ID
      • Edit User Permission by ID
      • Delete User Permission by ID
      • Batch Delete Users
    • Analytics APIs
      • Get Tokens by Date
      • Get Tokens by Segment
      • Get User Tokens
      • Get Agent Tokens
      • Get Team Tokens
      • Get Query Count by Date
      • Get Query Count by Segment
      • Get Total Count
      • Get Daily Chat Engagement
      • Get Weekly Chat Engagement
      • Get Monthly Chat Engagement
      • Get User Engagement
      • Get Daily Chatlog Tokens
      • Get Weekly Chatlog Tokens
      • Get Monthly Chatlog Tokens
      • Get Agent Engagement
      • Get Engagement by Team
      • Get Engagement by User
      • Get Recently Active Agents
      • Get Recent Users
    • Notification APIs
      • Send Notification To User
      • Read Notification By ID
  1. Evaluation APIs

Update Evaluation Test

PUT
/api/agent/{agent_id}/evaluation/{eval_id}/
Evaluation APIs
Updates an existing evaluation test for the specified agent with new metrics and query data.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/api/agent//evaluation//' \
--header 'Content-Type: application/json' \
--data-raw '{
    "metrics": {
        "answer_similarity": null,
        "answer_relevancy": null,
        "faithfulness": null,
        "context_recall": null
    },
    "query_data": []
}'
Response Response Example
{
    "success": true,
    "message": "Evaluation updated successfully.",
    "data": {
        "id": 5,
        "created_by": "user@example.com",
        "created_on": "2024-10-22T19:59:47.758221Z",
        "modified_by": "user@example.com",
        "modified_on": "2024-10-22T20:00:12.172350Z",
        "answer_similarity": null,
        "answer_relevancy": null,
        "faithfulness": null,
        "context_recall": null,
        "query_result": [],
        "status": "Completed",
        "agent": 3,
        "evaluation_dataset_id": 9
    }
}

Request

Path Params
agent_id
integer 
required
The unique identifier of the agent.
Example:
3
eval_id
integer 
required
The unique identifier of the evaluation test.
Example:
5
Body Params application/json
metrics
object 
optional
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_data
array [object] 
optional
Example:
[]
Examples

Responses

🟢200OK
application/json
Evaluation updated successfully.
Body
success
boolean 
optional
Example:
true
message
string 
optional
Example:
Evaluation updated successfully.
data
object 
optional
id
integer 
optional
Example:
5
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:
user@example.com
modified_on
string <date-time>
optional
Example:
2024-10-22T20:00:12.172350Z
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:
Completed
agent
integer 
optional
Example:
3
evaluation_dataset_id
integer 
optional
Example:
9
🟠400Bad Request
🟠401Unauthorized
Previous
Get All Evaluation Tests for an Agent
Next
Get One Evaluation Test