- Overview
- Changelog
- Versioning
- Legacy
- Introduction to Legacy APIs
- Agent
- Agent Corpus Connection
- Agent Response
- Create Agent Response
- Get All Agent Responses
- Get Agent Responses By User
- Get Agent Responses By Project
- Get Agent Responses By Chat Thread
- Get Agent Response
- Delete Agent Response
- Create Agent Response Comment
- Get Agent Response Comment
- Get Agent Response Dashboard
- Create Agent Response Feedback
- Create Agent Response Log
- Pin Agent Response
- Unpin Agent Response
- Get Pinned Agent Responses
- Agent Reviews
- Agent Rating
- Agent Alias
- Agent Access
- Agent Type
- Agent User
- Agent Tags
- Agent Vote
- Agent Comment
- Chat Thread
- Create Chat Thread
- Get All Chat Threads Of An Agent
- Get All Chat Threads With Admin Panel Filters And Pagination
- Get Reduced Chatlogs by Thread ID for Admin Panel
- Get Chat Thread
- Edit Chat Thread
- Delete Chat Thread
- Add ChatThread-Corpus Connection
- Get ChatThread-Corpus Connection
- Delete ChatThread-Corpus Connection
- Project
- User Project
- Document
- Corpus
- Notification
- Feature Flag
- Get All Feature Flags
- Get DALL-E Feature Flag
- Get Share Agent Feature Flag
- Get Agent Alias Feature Flag
- Get SharePoint Index Feature Flag
- Get Chat Agent Creation Feature Flag
- Get OAuth Feature Flags
- Get Google OAuth Feature Flag
- Get LinkedIn OAuth Feature Flag
- Get MS SSO OAuth Feature Flag
- Get Github OAuth Feature Flag
- Team
- User
- Email Indexing Authorization
- Conversation Starters
- Tool
- Agent Tool Connection
- Organization Tool
- API Tool Template
- LLM Config
- Latest
- Introduction to Latest APIs
- Agents
- Agent Access
- Agent Alias
- Agent Tags
- Agent Chat Threads
- Agent Comment
- Agent Rating
- Agent Review
- Agent Tools
- Agent User
- Agent User Permission
- Agent Vote
- Agent Type
- Get all Agents
- Create a new Agent
- Get an Agent
- Update an Agent
- Delete an Agent
- Activate an Agent
- Get Agent-Corpus Connections
- Delete Agent-Corpus Connections
- Get Agent-Corpus Connection Details
- Create Agent-Corpus Connection
- Update Agent-Corpus Connection
- Delete Agent-Corpus Connection
- Get agent history with pagination
- Restore an agent to a previous checkpoint
- Get Agent Prompt History
- Create a Recent Agent
- Delete a Recent Agent
- Get Agent Details with Starred Status
- Create Starred Agent
- Delete Starred Agent
- Get the Status of an Agent
- Get User's Team Role for an Agent
- Create or Update an Agent using the Agent Builder
- Get Agent Filter
- Generate an image for an agent based on the provided description
- Get all Agents by Project
- Get list of Recent Agents
- Get all Starred Agents of the Authenticated User
- Get Agents accessible to the Current User across their Teams
- Get Agents by Project team, User team
- Agent Response
- Get an Agent Response
- Create Agent Response
- Delete an Agent Response
- Get Comments for Agent Response
- Create a Comment for Agent Response
- Create a Feedback for an Agent Response
- Pin an Agent Response
- Unpin an Agent Response
- Get Supporting Content of an Agent Response
- Get Thoughts of an Agent Response
- Get Agent Responses based on filters
- Get Agent Responses of an Agent
- Create Agent Response Log
- Get Pinned Agent Responses
- Update an Agent Response
- Agent Response Steps
- Configurations
- Conversation Starters
- Evaluations
- Retrieve all evaluations or filter by datasetGET
- Create a new evaluationPOST
- Delete a set of evaluations or a specific evaluationDELETE
- Retrieve all evaluation datasets for a specific agentGET
- Create a new evaluation dataset for the given agentPOST
- Delete multiple datasets or all datasets for an agentDELETE
- Retrieve a specific evaluationGET
- Update an evaluation runPUT
- Delete a specific evaluationDELETE
- List query results for an evaluation runGET
- Create a query result and save metricsPOST
- Retrieve a specific datasetGET
- Update an evaluation datasetPUT
- Delete a specific datasetDELETE
- Retrieve queries for an evaluation datasetGET
- Create a new query for evaluationPOST
- Retrieve all unique tags from all datasets in the organizationGET
- Get a specific metric result by IDGET
- Retrieve all metrics or filter by category nameGET
- Create a new metricPOST
- Retrieve a specific metricGET
- Update a metricPUT
- Delete a metricDELETE
- Get all metric results for a specific metricGET
- Create a new metric result entry for the given metricPOST
- Retrieve a specific evaluation queryGET
- Update an evaluation queryPUT
- Delete an evaluation queryDELETE
- Get a specific query result with metricsGET
- Update a query resultPUT
- Guardrails
- Analytics
- Get Agent Cost Data
- Get Agent Document Count Data
- Get Agent Indexing Mode Data
- Get Agent Most Active Data
- Get Agent Query Count Data
- Get Recent Agent Data
- Get Agent Summary Statistics
- Get Agent Token Data
- Get Agent Vote Data
- Get Corpus Document Count Data
- Get Corpus Indexing Mode Data
- Get Cost Data
- Get Document Count Data
- Get Indexing Mode Data
- Get Project Cost Data
- Get Project Document Count Data
- Get Project Indexing Mode Data
- Get Project Most Active Data
- Get Project Query Count Data
- Get Recent Project Data
- Get Project Summary Statistics
- Get Project Token Data
- Get Project Vote Data
- Get Overall Summary Statistics
- Get Team Cost Data
- Get Team Document Count Data
- Get Team Indexing Mode Data
- Get Team Most Active Data
- Get Team Query Count Data
- Get Recent Team Data
- Get Team Summary Statistics
- Get Team Token Data
- Get Team Vote Data
- Get Total Entity Counts
- Get User Cost Data
- Get User Document Count Data
- Get User Indexing Mode Data
- Get User Most Active Data
- Get User Query Count Data
- Get Recent User Data
- Get User Summary Statistics
- Get User Token Data
- Get User Vote Data
- Get Vote Count Data
- Get Query Count Data
- Get Token Data
- Chat Logs
- Chat Thread
- Corpora
- Get all Corpus
- Create a Corpus
- Get a Corpus
- Update a Corpus
- Delete a Corpus
- Get Corpus Agent Connections
- Get Default Corpus Agent Connection
- Annotate/Tag a Corpus
- Get Conversation Starters for a Corpus
- Get all Documents for a Corpus
- Upload a Document to a Corpus
- Delete Document(s) from a Corpus
- Check Duplicate Documents in a Corpus
- Get all Permissions for a Corpus
- Create a new Permission for a Corpus
- Delete a user permission for a corpus
- Get all user permissions for a corpus
- Documents
- Feature Flags
- Get All Feature Flags
- Get Agent Alias Feature Flag
- Get Api Tools Feature Flag
- Get Chat Agent Creation Feature Flag
- Get dall_e Image Generation Feature Flag
- Get Developer Portal Feature Flag
- Get Guardrail Feature Flag
- Get PII Redaction Feature Flag
- Get Share Agent Feature Flag
- Get Sharepoint Connector Feature Flag
- Get Sharepoint Index Feature Flag
- Get Youtube Index Feature Flag
- Notifications
- Organizations
- Get all Configurations
- Get active configuration for an Organization
- Get the Model Deployment for an Organization
- Get all Tools in an Organization
- Disable a Tool for all Agents in an Organization
- Enable a Tool for all Agents in an Organization
- Get all API Tool Templates
- Create a new API Tool Template
- Create a new API tool
- Create an attachment tool
- Create a new RAG tool in an Organization
- Create a Web Search Tool in an Organization
- Get all Users in an Organization
- Create a User in an Organization
- Get all Configurations of user's Organization
- Get all LLM configurations of the user's Organization
- Get a specific LLM configuration by ID
- Projects
- Retrieve all Projects
- Create a Project
- Get a Project
- Update a Project
- Delete a Project
- Get Agent Responses using Project ID
- Add a Recent Project for a User
- Add Users to a Project
- Remove a User from a Project
- Get all Workflows for a Project
- Get multiple Projects by their IDs
- Get Projects based on filters
- Get Recent Projects for a User
- Get Projects with Team Details
- Teams
- Tools
- Users
- Get a User
- Update a User
- Delete a User
- Get Agent Responses of a User
- Get all User Permissions
- Create a new User Organization Permission
- Update the Organization Permission of a User
- Delete a User Organization Permission
- Get Projects of a User
- Get all Workflow Tables for a User
- Get all Workflows for a User
- Delete multiple Users
- Get a specific User by user_email
- Get all Users
- Get authenticated User
- Get User Projects
- Workflows
- Get all Workflows
- Create a Workflow
- Get a Workflow
- Update a Workflow
- Delete a Workflow
- Get all Workflow Chat Threads
- Create a Workflow Chat Thread
- Get a Workflow Chat Thread
- Update a Workflow Chat Thread
- Delete a Workflow Chat Thread
- Get all Workflow Chat Responses
- Create a Workflow Chat Response
- Delete a Workflow Response
- Run a Workflow
- Create a Workflow Feedback
- Create a Workflow Review
- Retrieve a list of reviews for a given workflow response
Retrieve a specific metric
GET
/api/v2/evaluations/metrics/{metric_id}
JSON response with object containing metric details
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https:///api/v2/evaluations/metrics/' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer 'Response Response Example
200 - Success
{
"success": true,
"message": "Metric retrieved successfully",
"data": {
"id": 1,
"name": "answer_similarity",
"display_name": "test_dummy",
"category_name": "Generation",
"description": null
}
}Request
Path Params
Header Params
Responses
🟢200OK
application/json
Body
🔴500Server Error