EGP API V4

Models
Knowledge Bases
Chunks
- Rank Chunkspost
Agents
- Execute Agentpost
Completions
- Create Completionpost
Chat Completions
- Create Chat Completionpost
Users
Accounts
- Create accountpost
Organizations
- Get organizationget
Question Sets
Evaluations
Evaluation Configs
Evaluation Datasets
Studio Projects
Application Specs
Questions
Knowledge Base Data Sources
Model Templates V3 (Beta)
Model server
/v4/serving
- Fixed Server interface for Model execution by named aliasget
/v4/serving/{model_server_id}
- Fixed Server interface for Model execution by named aliasget
/v4/serving/a/{alias}
- Fixed Server interface for Model execution by named aliasget
Fine Tuning Jobs V3 (Beta)
Training Datasets V3 (Beta)
package deployments
Beta
Applications
ChatThreads
Interactions
- Create Application Interactionpost
MonitoringDashboard
Chat Themes
account groups
- Upsert General Role Restrictionput
account
- Upsert General Role Restrictionput
Guardrails

EGP API V4

Models
Knowledge Bases
Chunks
- Rank Chunkspost
Agents
- Execute Agentpost
Completions
- Create Completionpost
Chat Completions
- Create Chat Completionpost
Users
Accounts
- Create accountpost
Organizations
- Get organizationget
Question Sets
Evaluations
Evaluation Configs
Evaluation Datasets
Studio Projects
Application Specs
Questions
Knowledge Base Data Sources
Model Templates V3 (Beta)
Model server
/v4/serving
- Fixed Server interface for Model execution by named aliasget
/v4/serving/{model_server_id}
- Fixed Server interface for Model execution by named aliasget
/v4/serving/a/{alias}
- Fixed Server interface for Model execution by named aliasget
Fine Tuning Jobs V3 (Beta)
Training Datasets V3 (Beta)
package deployments
Beta
Applications
ChatThreads
Interactions
- Create Application Interactionpost
MonitoringDashboard
Chat Themes
account groups
- Upsert General Role Restrictionput
account
- Upsert General Role Restrictionput
Guardrails

Update Evaluation

patch https://api.egp.scale.com/v4/evaluations/{evaluation_id}

Description

Updates a evaluation

Details

This API can be used to update the evaluation that matches the ID that was passed in as a path parameter. To use this API, pass in the id that was returned from your Create Evaluation API call as a path parameter.

Review the request schema to see the fields that can be updated.

URL Expired

The URL for this request expired after 30 days.

Path Params

evaluation_id

string

required

Body Params

Responses

Response body

object

name

string

required

description

string

required

status

string

required

PENDING COMPLETED FAILED

application_spec_id

string

required

application_variant_id

string

tags

object

Has additional fields

evaluation_config

object

Has additional fields

evaluation_config_id

string

The ID of the associated evaluation config.

completed_at

date-time

The date and time that all test case results for the evaluation were completed for the evaluation in ISO format.

total_test_case_result_count

integer

required

The total number of test case results for the evaluation

completed_test_case_result_count

integer

required

The number of test case results that have been completed for the evaluation

annotation_config

object

Annotation configuration for tasking

annotation_config_type

string

Defaults to flexible

generation flexible summarization multiturn translation

components

array of arrays of objects

Components

array of objects

object

optional

boolean

Defaults to false

data_loc

array of strings

required

DataLoc*

label

string

direction

string

Defaults to row

col row

llm_prompt

object

question_id_to_annotation_config

object

Specifies the annotation configuration to use for specific questions.

metric_config

object

Specifies the config for the metrics to be computed.

components

array of objects

required

Components*

object

type

string

required

rouge bleu meteor cosine_similarity f1

name

string

required

mappings

object

params

object

Has additional fields

string

required

The unique identifier of the entity.

created_at

date-time

required

The date and time when the entity was created in ISO format.

account_id

string

required

The ID of the account that owns the given entity.

created_by_user_id

string

required

The user who originally created the entity.

archived_at

date-time

The date and time when the entity was archived in ISO format.

Response body

object

detail

array of objects

Detail

object

loc

array

required

Location*

msg

string

required

type

string

required

Updated 9 months ago

Get Evaluation

Delete Evaluation

Did this page help you?

Language

Credentials

Header

Request


xxxxxxxxxx
12
1
curl --request PATCH \
2
     --url https://api.egp.scale.com/v4/evaluations/evaluation_id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "annotation_config": {
8
    "direction": "row"
9
  },
10
  "restore": false
11
}
12
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 9 months ago

Get Evaluation

Delete Evaluation

Did this page help you?

EGP API V4
Models
Delete Deploymentdelete
Update Deploymentpatch
Get Deploymentget
Delete Model Groupdelete
Update Model Grouppatch
Get Model Groupget
Create Model Grouppost
List Model Groupsget
Delete Modeldelete
Update Modelpatch
Get Modelget
Create Modelpost
List Modelsget
Get Model usage for a groupget
Add model to grouppost
Get Model usage for one deploymentget
List All Model Deploymentsget
Get Model usage by model nameget
List Model Deployments of a Modelget
Deploy Modelpost
Generate chat completionpost
Generate completionpost
Generate rerankingpost
Generate text embeddingpost
Execute Model Deploymentpost
Knowledge Bases
Delete Upload Scheduledelete
Update Upload Schedulepatch
Get Upload Scheduleget
Create Upload Schedulepost
List Upload Schedulesget
Batch Delete Locally Stored Artifactspost
Test Knowledge Base Data Source credentialspost
Delete Single Chunk from Local Artifactdelete
Update Single Chunk data for local artifactput
Get Single Chunk Information and statusget
Create chunk for local chunk artifactspost
List Chunks of Artifacts with Paginationget
Delete Locally Stored Artifactdelete
Patch Artifact Informationpatch
Get Tracked Artifact Detailsget
List Tracked Artifactsget
Cancel Upload Jobpost
Get Upload Jobget
List Upload Jobsget
Submit Upload Jobpost
Submit Upload Job with local filespost
Delete Knowledge Base Data Source Connectionpost
Query Relevant Chunkspost
Get Chunksget
List Upload Jobsget
Delete Knowledge Basedelete
Patch Knowledge Basepatch
Get Knowledge Baseget
List Knowledge Basesget
Create Knowledge Basepost
Chunks
Rank Chunkspost
Agents
Execute Agentpost
Completions
Create Completionpost
Chat Completions
Create Chat Completionpost
Users
Get Userget
Update user infopatch
User infoget
Accounts
Create accountpost
Organizations
Get organizationget
Question Sets
Create Question Setpost
List Question Setsget
Delete Question Setdelete
Update Question Setpatch
Get Question Setget
Evaluations
List Historical Test Case Resultsget
Get All Versions of Test Case Resultget
Get Historical Test Case Resultget
Update Test Case Resultpatch
Get Test Case Resultget
Batch Create Test Case Resultspost
Create Test Case Resultpost
List Test Case Resultsget
Delete Evaluationdelete
Update Evaluationpatch
Get Evaluationget
Create Evaluationpost
List Evaluationsget
Get Hybrid Evaluation Metricsget
Get Evaluation Metricsget
List Contributor Metricsget
Get Contributor Metricsget
Update Evaluation Taskpatch
Batch assign tasks to userpatch
Claim Evaluation Taskpost
Evaluation Configs
Delete Evaluation Configdelete
Get Evaluation Configget
Create Evaluation Configpost
List Evaluation Configsget
Evaluation Datasets
Publish Evaluation Dataset Versionpost
Cancel Evaluation Dataset Generation Jobpost
Get Evaluation Dataset Generation Jobget
Create Evaluation Dataset Generation Jobpost
Get Evaluation Dataset Generation Jobsget
Approve Auto Generated Test Cases Batchpost
Publish Latest Evaluation Dataset Versionpost
Approve Autogenerated Draft Test Casepost
Delete Autogenerated Draft Test Casedelete
Update Autogenerated Draft Test Casepatch
Get Autogenerated Draft Test Caseget
List Autogenerated Draft Test Casesget
Create Autogenerated Draft Test Casepost
List Historical Test Casesget
Wipe Full History of Test Casesdelete
Get All Versions of Test Caseget
Get Historical Test Caseget
Delete Test Casedelete
Update Test Casepatch
Get Test Caseget
Batch Create Test Casespost
Create Test Casepost
List Test Casesget
Get Evaluation Dataset Versionget
Create Evaluation Dataset Versionpost
List Evaluation Dataset Versionsget
Delete Evaluation Datasetdelete
Update Evaluation Datasetpatch
Get Evaluation Datasetget
Create Evaluation Datasetpost
List Evaluation Datasetsget
Studio Projects
Delete Studio Projectdelete
Update Studio Projectpatch
Get Studio Projectget
Create Studio Projectpost
List Studio Projectsget
Application Specs
Delete Application Specdelete
Update Application Specpatch
Get Application Specget
Create Application Specpost
List Application Specsget
Questions
Get Questionget
Create Questionpost
List Questionsget
Knowledge Base Data Sources
Delete Knowledge Base Data Sourcedelete
Update Knowledge Base Data Sourcepatch
Get Knowledge Base Data Sourceget
Create Knowledge Base Data Sourcepost
List Knowledge Base Data Sourcesget
Model Templates V3 (Beta)
Delete Model Templatedelete
Get Model Templateget
Create Model Templatepost
List Model Templatesget
Model server
Rollback backend of the Model Serverpost
Change backend of the Model Serverput
Get current deployment of the Model Serverget
Create a new Model Serverpost
Fixed Server interface for Model execution by named aliaspost
Fixed Server interface for Model executionpost
/v4/serving
Fixed Server interface for Model execution by named aliasget
/v4/serving/{model_server_id}
Fixed Server interface for Model execution by named aliasget
/v4/serving/a/{alias}
Fixed Server interface for Model execution by named aliasget
Fine Tuning Jobs V3 (Beta)
Get fine tuning job eventsget
Delete Fine Tuning Jobdelete
Get Fine Tuning Jobget
Create Fine Tuning Jobpost
List Fine Tuning Jobsget
Training Datasets V3 (Beta)
Get Training Dataset Contentsget
Delete Training Datasetdelete
Get Training Datasetget
Create Training Datasetpost
List Training Datasetsget
package deployments
Verify that the prerequisites for installing a specific package version are metpost
Install a deployment packagespost
Copy a deployment package to control plane hookpost
Install a deployment packagespost
Beta
Get File Contentget
Update Filepatch
Delete Filedelete
Get Fileget
List Filesget
Upload Filepost
Completionspost
Chat Completionspost
Applications
Publish Application Variantpost
Patch Application Variant Guardrailspatch
Upload Application Filespost
Create New Application Threadpost
List Application Threadsget
Validate Applicationpost
Process Application By Aliaspost
Process Deployed Application For Threadpost
Process Application By Idpost
Process Applicationpost
Get Application Schemasget
Create Application With Variantpost
Get Application Test Case Outputget
Batch Create Application Test Case Outputspost
List Application Test Case Outputsget
Get Application Variant Reportget
Create Application Variant Reportpost
List Application Variant Reportsget
Update Application Deploymentpatch
Get Application Deploymentget
Create Application Deploymentpost
List Application Deploymentsget
Delete Application Variantdelete
Update Application Variantpatch
Get Application Variantget
Create Application Variantpost
List Application Variantsget
ChatThreads
Delete Interaction Feedbackdelete
Add Feedback To Thread Entryput
Patch Chat Thread Entrypatch
Delete Chat Threaddelete
Patch Chat Threadpatch
Get Thread Messagesget
Interactions
Create Application Interactionpost
MonitoringDashboard
Get Timeseries Metricget
Get Scalar Metricget
Get Dashboard Schemaget
Chat Themes
Get Themeget
Create Themepost
List Themesget
account groups
Upsert General Role Restrictionput
account
Upsert General Role Restrictionput
Guardrails
Execute Guardrailpost
List Attack Categories With Descriptionsget
Patch Guardrailpatch
Get Guardrailget
Create Guardrailpost
List Guardrailsget

EGP API V4
Models
Delete Deploymentdelete
Update Deploymentpatch
Get Deploymentget
Delete Model Groupdelete
Update Model Grouppatch
Get Model Groupget
Create Model Grouppost
List Model Groupsget
Delete Modeldelete
Update Modelpatch
Get Modelget
Create Modelpost
List Modelsget
Get Model usage for a groupget
Add model to grouppost
Get Model usage for one deploymentget
List All Model Deploymentsget
Get Model usage by model nameget
List Model Deployments of a Modelget
Deploy Modelpost
Generate chat completionpost
Generate completionpost
Generate rerankingpost
Generate text embeddingpost
Execute Model Deploymentpost
Knowledge Bases
Delete Upload Scheduledelete
Update Upload Schedulepatch
Get Upload Scheduleget
Create Upload Schedulepost
List Upload Schedulesget
Batch Delete Locally Stored Artifactspost
Test Knowledge Base Data Source credentialspost
Delete Single Chunk from Local Artifactdelete
Update Single Chunk data for local artifactput
Get Single Chunk Information and statusget
Create chunk for local chunk artifactspost
List Chunks of Artifacts with Paginationget
Delete Locally Stored Artifactdelete
Patch Artifact Informationpatch
Get Tracked Artifact Detailsget
List Tracked Artifactsget
Cancel Upload Jobpost
Get Upload Jobget
List Upload Jobsget
Submit Upload Jobpost
Submit Upload Job with local filespost
Delete Knowledge Base Data Source Connectionpost
Query Relevant Chunkspost
Get Chunksget
List Upload Jobsget
Delete Knowledge Basedelete
Patch Knowledge Basepatch
Get Knowledge Baseget
List Knowledge Basesget
Create Knowledge Basepost
Chunks
Rank Chunkspost
Agents
Execute Agentpost
Completions
Create Completionpost
Chat Completions
Create Chat Completionpost
Users
Get Userget
Update user infopatch
User infoget
Accounts
Create accountpost
Organizations
Get organizationget
Question Sets
Create Question Setpost
List Question Setsget
Delete Question Setdelete
Update Question Setpatch
Get Question Setget
Evaluations
List Historical Test Case Resultsget
Get All Versions of Test Case Resultget
Get Historical Test Case Resultget
Update Test Case Resultpatch
Get Test Case Resultget
Batch Create Test Case Resultspost
Create Test Case Resultpost
List Test Case Resultsget
Delete Evaluationdelete
Update Evaluationpatch
Get Evaluationget
Create Evaluationpost
List Evaluationsget
Get Hybrid Evaluation Metricsget
Get Evaluation Metricsget
List Contributor Metricsget
Get Contributor Metricsget
Update Evaluation Taskpatch
Batch assign tasks to userpatch
Claim Evaluation Taskpost
Evaluation Configs
Delete Evaluation Configdelete
Get Evaluation Configget
Create Evaluation Configpost
List Evaluation Configsget
Evaluation Datasets
Publish Evaluation Dataset Versionpost
Cancel Evaluation Dataset Generation Jobpost
Get Evaluation Dataset Generation Jobget
Create Evaluation Dataset Generation Jobpost
Get Evaluation Dataset Generation Jobsget
Approve Auto Generated Test Cases Batchpost
Publish Latest Evaluation Dataset Versionpost
Approve Autogenerated Draft Test Casepost
Delete Autogenerated Draft Test Casedelete
Update Autogenerated Draft Test Casepatch
Get Autogenerated Draft Test Caseget
List Autogenerated Draft Test Casesget
Create Autogenerated Draft Test Casepost
List Historical Test Casesget
Wipe Full History of Test Casesdelete
Get All Versions of Test Caseget
Get Historical Test Caseget
Delete Test Casedelete
Update Test Casepatch
Get Test Caseget
Batch Create Test Casespost
Create Test Casepost
List Test Casesget
Get Evaluation Dataset Versionget
Create Evaluation Dataset Versionpost
List Evaluation Dataset Versionsget
Delete Evaluation Datasetdelete
Update Evaluation Datasetpatch
Get Evaluation Datasetget
Create Evaluation Datasetpost
List Evaluation Datasetsget
Studio Projects
Delete Studio Projectdelete
Update Studio Projectpatch
Get Studio Projectget
Create Studio Projectpost
List Studio Projectsget
Application Specs
Delete Application Specdelete
Update Application Specpatch
Get Application Specget
Create Application Specpost
List Application Specsget
Questions
Get Questionget
Create Questionpost
List Questionsget
Knowledge Base Data Sources
Delete Knowledge Base Data Sourcedelete
Update Knowledge Base Data Sourcepatch
Get Knowledge Base Data Sourceget
Create Knowledge Base Data Sourcepost
List Knowledge Base Data Sourcesget
Model Templates V3 (Beta)
Delete Model Templatedelete
Get Model Templateget
Create Model Templatepost
List Model Templatesget
Model server
Rollback backend of the Model Serverpost
Change backend of the Model Serverput
Get current deployment of the Model Serverget
Create a new Model Serverpost
Fixed Server interface for Model execution by named aliaspost
Fixed Server interface for Model executionpost
/v4/serving
Fixed Server interface for Model execution by named aliasget
/v4/serving/{model_server_id}
Fixed Server interface for Model execution by named aliasget
/v4/serving/a/{alias}
Fixed Server interface for Model execution by named aliasget
Fine Tuning Jobs V3 (Beta)
Get fine tuning job eventsget
Delete Fine Tuning Jobdelete
Get Fine Tuning Jobget
Create Fine Tuning Jobpost
List Fine Tuning Jobsget
Training Datasets V3 (Beta)
Get Training Dataset Contentsget
Delete Training Datasetdelete
Get Training Datasetget
Create Training Datasetpost
List Training Datasetsget
package deployments
Verify that the prerequisites for installing a specific package version are metpost
Install a deployment packagespost
Copy a deployment package to control plane hookpost
Install a deployment packagespost
Beta
Get File Contentget
Update Filepatch
Delete Filedelete
Get Fileget
List Filesget
Upload Filepost
Completionspost
Chat Completionspost
Applications
Publish Application Variantpost
Patch Application Variant Guardrailspatch
Upload Application Filespost
Create New Application Threadpost
List Application Threadsget
Validate Applicationpost
Process Application By Aliaspost
Process Deployed Application For Threadpost
Process Application By Idpost
Process Applicationpost
Get Application Schemasget
Create Application With Variantpost
Get Application Test Case Outputget
Batch Create Application Test Case Outputspost
List Application Test Case Outputsget
Get Application Variant Reportget
Create Application Variant Reportpost
List Application Variant Reportsget
Update Application Deploymentpatch
Get Application Deploymentget
Create Application Deploymentpost
List Application Deploymentsget
Delete Application Variantdelete
Update Application Variantpatch
Get Application Variantget
Create Application Variantpost
List Application Variantsget
ChatThreads
Delete Interaction Feedbackdelete
Add Feedback To Thread Entryput
Patch Chat Thread Entrypatch
Delete Chat Threaddelete
Patch Chat Threadpatch
Get Thread Messagesget
Interactions
Create Application Interactionpost
MonitoringDashboard
Get Timeseries Metricget
Get Scalar Metricget
Get Dashboard Schemaget
Chat Themes
Get Themeget
Create Themepost
List Themesget
account groups
Upsert General Role Restrictionput
account
Upsert General Role Restrictionput
Guardrails
Execute Guardrailpost
List Attack Categories With Descriptionsget
Patch Guardrailpatch
Get Guardrailget
Create Guardrailpost
List Guardrailsget

200Successful Response

422Validation Error