Knowledge Bases
- GETList Knowledge Bases
- POSTCreate Knowledge Base
- GETGet Knowledge Base
- DELDelete Knowledge Base
- PATCHPatch Knowledge Base
- GETList Upload Jobs
- GETGet Chunks
- POSTQuery Relevant Chunks
- POSTDelete Knowledge Base Data Source Connection
- POSTSubmit Upload Job with local files
- GETList Upload Jobs
- POSTSubmit Upload Job
- GETGet Upload Job
- POSTCancel Upload Job
- GETList Tracked Artifacts
- GETGet Tracked Artifact Details
- DELDelete Locally Stored Artifact
- PATCHPatch Artifact Information
- GETList Chunks of Artifacts with Pagination
- POSTCreate chunk for local chunk artifacts
- GETGet Single Chunk Information and status
- PUTUpdate Single Chunk data for local artifact
- DELDelete Single Chunk from Local Artifact
- POSTTest Knowledge Base Data Source credentials
- POSTBatch Delete Locally Stored Artifacts
- GETList Upload Schedules
- POSTCreate Upload Schedule
- GETGet Upload Schedule
- DELDelete Upload Schedule
- PATCHUpdate Upload Schedule
Agents
Completions
Chat Completions
Models
- POSTExecute Model Deployment
- POSTGenerate text embedding
- POSTGenerate reranking
- POSTGenerate completion
- POSTGenerate chat completion
- GETList Model Deployments of a Model
- POSTDeploy Model
- GETGet Model usage by model name
- GETList All Model Deployments
- GETGet Model usage for one deployment
- POSTAdd model to group
- GETGet Model usage for a group
- GETList Models
- POSTCreate Model
- GETGet Model
- DELDelete Model
- PATCHUpdate Model
- GETList Model Groups
- POSTCreate Model Group
- GETGet Model Group
- DELDelete Model Group
- PATCHUpdate Model Group
- GETGet Deployment
- DELDelete Deployment
- PATCHUpdate Deployment
Accounts
Organizations
Question Sets
Evaluations
- POSTClaim Evaluation Task
- PATCHUpdate Evaluation Task
- GETGet Contributor Metrics
- GETList Contributor Metrics
- GETGet Evaluation Metrics
- GETGet Hybrid Evaluation Metrics
- GETList Evaluations
- POSTCreate Evaluation
- GETGet Evaluation
- DELDelete Evaluation
- PATCHUpdate Evaluation
- GETList Test Case Results
- POSTCreate Test Case Result
- POSTBatch Create Test Case Results
- GETGet Test Case Result
- PATCHUpdate Test Case Result
- GETGet Historical Test Case Result
- GETList Historical Test Case Results
Evaluation Configs
Evaluation Datasets
- GETList Evaluation Datasets
- POSTCreate Evaluation Dataset
- GETGet Evaluation Dataset
- DELDelete Evaluation Dataset
- PATCHUpdate Evaluation Dataset
- GETList Evaluation Dataset Versions
- POSTCreate Evaluation Dataset Version
- GETGet Evaluation Dataset Version
- GETList Test Cases
- POSTCreate Test Case
- POSTBatch Create Test Cases
- GETGet Test Case
- DELDelete Test Case
- PATCHUpdate Test Case
- GETGet Historical Test Case
- GETList Historical Test Cases
- DELWipe Full History of Test Cases
- GETList Autogenerated Draft Test Cases
- POSTCreate Autogenerated Draft Test Case
- GETGet Autogenerated Draft Test Case
- DELDelete Autogenerated Draft Test Case
- PATCHUpdate Autogenerated Draft Test Case
- POSTApprove Autogenerated Draft Test Case
- POSTPublish Latest Evaluation Dataset Version
- POSTApprove Auto Generated Test Cases Batch
- GETGet Evaluation Dataset Generation Jobs
- POSTCreate Evaluation Dataset Generation Job
- GETGet Evaluation Dataset Generation Job
- POSTCancel Evaluation Dataset Generation Job
- POSTPublish Evaluation Dataset Version
Studio Projects
Application Specs
Knowledge Base Data Sources
Model Templates V3 (Beta)
Model server
API Reference
Fine Tuning Jobs V3 (Beta)
Training Datasets V3 (Beta)
package deployments
Beta
Applications
- GETList Application Variants
- POSTCreate Application Variant
- GETGet Application Variant
- DELDelete Application Variant
- PATCHUpdate Application Variant
- GETList Application Deployments
- POSTCreate Application Deployment
- GETGet Application Deployment
- PATCHUpdate Application Deployment
- GETList Application Variant Reports
- POSTCreate Application Variant Report
- GETGet Application Variant Report
- GETList Application Test Case Outputs
- POSTBatch Create Application Test Case Outputs
- GETGet Application Test Case Output
- POSTCreate Application With Variant
- GETGet Application Schemas
- POSTProcess Application
- POSTProcess Application By Id
- POSTProcess Deployed Application For Thread
- POSTValidate Application
- GETList Application Threads
- POSTCreate New Application Thread
- POSTUpload Application Files
- PATCHPatch Application Variant Guardrails
- POSTPublish Application Variant
ChatThreads
Interactions
MonitoringDashboard
Chat Themes
account groups
Get Evaluation
Description
Gets the details of a evaluation
Details
This API can be used to get information about a single evaluation by ID. To use this API, pass in the id that was returned from your Create Evaluation API call as a path parameter.
Review the response schema to see the fields that will be returned.
Authorizations
Path Parameters
Query Parameters
ApplicationSpec, AsyncJobs, EvaluationConfig, EvaluationDatasets Response
The ID of the account that owns the given entity.
The number of test case results that have been completed for the evaluation
The date and time when the entity was created in ISO format.
The user who originally created the entity.
The unique identifier of the entity.
PENDING, COMPLETED, FAILED The total number of test case results for the evaluation
Annotation configuration for tasking
generation, flexible, summarization, multiturn, translation col, row The ID of the account that owns the given entity.
The date and time when the entity was created in ISO format.
The description of the Application Spec
The unique identifier of the entity.
The name of the Application Spec
The date and time when the entity was archived in ISO format.
The user who originally created the entity.
Whether the application spec should run online evaluation, default is false
The date and time when the entity was archived in ISO format.
The date and time when the entity was created in ISO format.
The unique identifier of the entity.
The date and time when the entity was last updated in ISO format.
The date and time that all test case results for the evaluation were completed for the evaluation in ISO format.
The ID of the account that owns the given entity.
The date and time when the entity was created in ISO format.
The user who originally created the entity.
Evaluation type
studio, llm_auto, human, llm_benchmark The unique identifier of the entity.
The ID of the account that owns the given entity.
The date and time when the entity was created in ISO format.
The user who originally created the entity.
The unique identifier of the entity.
The ID of the account that owns the given entity.
The date and time when the entity was created in ISO format.
The user who originally created the entity.
The unique identifier of the entity.
The type of question
categorical, free_text, rating, number List of choices for the question. Required for CATEGORICAL questions.
Conditions for the question to be shown.
Whether the question is displayed as a dropdown in the UI.
Whether the question allows multiple answers.
Options for rating questions.
Maximum value for the rating
Minimum value for the rating
Number of steps in the rating scale
[To be deprecated in favor of question set question_id_to_config] Whether the question is required.
The date and time when the entity was archived in ISO format.
Instructions to answer questions
Specifies additional configurations to use for specific questions in the context of the question set. For example, {<question_a_id>: {required: true}, <question_b_id>: {required: true}} sets two questions as required.
The name of the model to be used for auto-evaluation
gpt-4-32k-0613, gpt-4-turbo-preview, gpt-4-turbo-2024-04-09, llama-3-70b-instruct, llama-3-1-70b-instruct The ID of the associated evaluation config.
The ID of the account that owns the given entity.
The date and time when the entity was created in ISO format.
The user who originally created the entity.
The unique identifier of the entity.
The name of the dataset
The schema type of the dataset.
GENERATION, FLEXIBLE The date and time when the entity was last updated in ISO format.
The date and time when the entity was archived in ISO format.
Metadata about the Evaluation Dataset that it is associated with
ID of the knowledge base that the evaluation dataset is associated with.
Boolean to check whether or not the knowledge base has been uploaded to since publication of the dataset.
summarization, translation The vendor of the evaluation dataset (e.g. 'Scale' for Scale off-the-shelf datasets). Null if the evaluation dataset is not from a vendor (e.g., is created by the customer).
scale Specifies the annotation configuration to use for specific questions.
generation, flexible, summarization, multiturn, translation col, row