diff --git a/api-reference/custom_api_keys/list_custom_api_keys.mdx b/api-reference/custom_api_keys/list_custom_api_keys.mdx
index b476ef206..9472d5283 100644
--- a/api-reference/custom_api_keys/list_custom_api_keys.mdx
+++ b/api-reference/custom_api_keys/list_custom_api_keys.mdx
@@ -34,10 +34,16 @@ print(response.text)
```json 200
-{
- "name": "string",
- "value": "string"
-}
+[
+ {
+ "name": "custom_key_1",
+ "value": "****alue_1"
+ },
+ {
+ "name": "custom_key_2",
+ "value": "****alue_2"
+ }
+]
```
diff --git a/api-reference/efficiency_benchmarks/delete_benchmark.mdx b/api-reference/efficiency_benchmarks/delete_benchmark.mdx
index c7bc24f09..bf225e269 100644
--- a/api-reference/efficiency_benchmarks/delete_benchmark.mdx
+++ b/api-reference/efficiency_benchmarks/delete_benchmark.mdx
@@ -41,7 +41,9 @@ print(response.text)
```json 200
-{}
+{
+ "info": "Benchmark deleted successfully!"
+}
```
```json 422
diff --git a/api-reference/evaluations/delete_evaluations.mdx b/api-reference/evaluations/delete_evaluations.mdx
index be5086a53..c23bc076d 100644
--- a/api-reference/evaluations/delete_evaluations.mdx
+++ b/api-reference/evaluations/delete_evaluations.mdx
@@ -51,7 +51,9 @@ print(response.text)
```json 200
-{}
+{
+ "info": "Evaluation deleted successfully!"
+}
```
```json 422
diff --git a/api-reference/evaluations/eval_status.mdx b/api-reference/evaluations/eval_status.mdx
index 07b1cf537..cc3095798 100644
--- a/api-reference/evaluations/eval_status.mdx
+++ b/api-reference/evaluations/eval_status.mdx
@@ -67,7 +67,22 @@ print(response.text)
```json 200
-{}
+{
+ "responses": {
+ "last_updated": "2024-08-19 13:58:20.866092",
+ "num_failed": 0,
+ "num_processed": 3,
+ "num_remaining": 0
+ },
+ "judgements": {
+ "judge_model_a": {
+ "last_updated": "2024-08-19 13:58:20.866092",
+ "num_failed": 0,
+ "num_processed": 3,
+ "num_remaining": 0
+ }
+ }
+}
```
```json 422
diff --git a/api-reference/evaluators/create_evaluator.mdx b/api-reference/evaluators/create_evaluator.mdx
index 76deed8ee..129584f50 100644
--- a/api-reference/evaluators/create_evaluator.mdx
+++ b/api-reference/evaluators/create_evaluator.mdx
@@ -73,7 +73,9 @@ print(response.text)
```json 200
-{}
+{
+ "info": "Evaluator created successfully!"
+}
```
```json 422
diff --git a/api-reference/evaluators/delete_evaluator.mdx b/api-reference/evaluators/delete_evaluator.mdx
index b2eb4bcac..6ac17ab0c 100644
--- a/api-reference/evaluators/delete_evaluator.mdx
+++ b/api-reference/evaluators/delete_evaluator.mdx
@@ -40,7 +40,9 @@ print(response.text)
```json 200
-{}
+{
+ "info": "Evaluator deleted successfully!"
+}
```
```json 422
diff --git a/api-reference/evaluators/get_evaluator.mdx b/api-reference/evaluators/get_evaluator.mdx
index ee68876ee..6da14065d 100644
--- a/api-reference/evaluators/get_evaluator.mdx
+++ b/api-reference/evaluators/get_evaluator.mdx
@@ -42,7 +42,13 @@ print(response.text)
```json 200
-{}
+{
+ "class_config": "...",
+ "client_side": "false",
+ "eval_name": "evaluator",
+ "judge_models": "claude-3.5-sonnet@aws-bedrock",
+ "system_prompt": "..."
+}
```
```json 422
diff --git a/api-reference/evaluators/list_evaluators.mdx b/api-reference/evaluators/list_evaluators.mdx
index 97022eb11..b7a2da130 100644
--- a/api-reference/evaluators/list_evaluators.mdx
+++ b/api-reference/evaluators/list_evaluators.mdx
@@ -34,7 +34,11 @@ print(response.text)
```json 200
-{}
+[
+ "evaluator_a",
+ "evaluator_b",
+ "evaluator_c"
+]
```
diff --git a/api-reference/evaluators/rename_evaluator.mdx b/api-reference/evaluators/rename_evaluator.mdx
index 0e261e775..29fc32a95 100644
--- a/api-reference/evaluators/rename_evaluator.mdx
+++ b/api-reference/evaluators/rename_evaluator.mdx
@@ -44,7 +44,9 @@ print(response.text)
```json 200
-{}
+{
+ "info": "Evaluator renamed successfully!"
+}
```
```json 422
diff --git a/api-reference/openapi.json b/api-reference/openapi.json
index 593e3878a..1283ec6f2 100644
--- a/api-reference/openapi.json
+++ b/api-reference/openapi.json
@@ -963,7 +963,17 @@
},
"type": "array",
"title": "Response List Custom Api Keys V0 Custom Api Key List Get"
- }
+ },
+ "example": [
+ {
+ "name": "custom_key_1",
+ "value": "****alue_1"
+ },
+ {
+ "name": "custom_key_2",
+ "value": "****alue_2"
+ }
+ ]
}
}
}
@@ -1325,7 +1335,10 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {},
+ "example": {
+ "info": "Evaluator created successfully!"
+ }
}
}
},
@@ -1372,7 +1385,14 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {},
+ "example": {
+ "class_config": "...",
+ "client_side": "false",
+ "eval_name": "evaluator",
+ "judge_models": "claude-3.5-sonnet@aws-bedrock",
+ "system_prompt": "..."
+ }
}
}
},
@@ -1419,7 +1439,10 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {},
+ "example": {
+ "info": "Evaluator deleted successfully!"
+ }
}
}
},
@@ -1480,7 +1503,10 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {},
+ "example": {
+ "info": "Evaluator renamed successfully!"
+ }
}
}
},
@@ -1510,7 +1536,12 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {},
+ "example": [
+ "evaluator_a",
+ "evaluator_b",
+ "evaluator_c"
+ ]
}
}
}
@@ -1779,7 +1810,10 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {},
+ "example": {
+ "info": "Evaluation deleted successfully!"
+ }
}
}
},
@@ -1852,7 +1886,23 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {},
+ "example": {
+ "responses": {
+ "last_updated": "2024-08-19 13:58:20.866092",
+ "num_failed": 0,
+ "num_processed": 3,
+ "num_remaining": 0
+ },
+ "judgements": {
+ "judge_model_a": {
+ "last_updated": "2024-08-19 13:58:20.866092",
+ "num_failed": 0,
+ "num_processed": 3,
+ "num_remaining": 0
+ }
+ }
+ }
}
}
},
@@ -2130,7 +2180,10 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {},
+ "example": {
+ "info": "Benchmark deleted successfully!"
+ }
}
}
},