Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@vedpatwardhan
vedpatwardhan committed Sep 2, 2024
1 parent a83927e commit aba8a41
Show file tree
Hide file tree
Showing 10 changed files with 115 additions and 21 deletions.
14 changes: 10 additions & 4 deletions api-reference/custom_api_keys/list_custom_api_keys.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,16 @@ print(response.text)
<ResponseExample>

```json 200
{
"name": "string",
"value": "string"
}
[
{
"name": "custom_key_1",
"value": "****alue_1"
},
{
"name": "custom_key_2",
"value": "****alue_2"
}
]
```

</ResponseExample>
4 changes: 3 additions & 1 deletion api-reference/efficiency_benchmarks/delete_benchmark.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ print(response.text)
<ResponseExample>

```json 200
{}
{
"info": "Benchmark deleted successfully!"
}
```

```json 422
Expand Down
4 changes: 3 additions & 1 deletion api-reference/evaluations/delete_evaluations.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@ print(response.text)
<ResponseExample>

```json 200
{}
{
"info": "Evaluation deleted successfully!"
}
```

```json 422
Expand Down
17 changes: 16 additions & 1 deletion api-reference/evaluations/eval_status.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,22 @@ print(response.text)
<ResponseExample>

```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
Expand Down
4 changes: 3 additions & 1 deletion api-reference/evaluators/create_evaluator.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ print(response.text)
<ResponseExample>

```json 200
{}
{
"info": "Evaluator created successfully!"
}
```

```json 422
Expand Down
4 changes: 3 additions & 1 deletion api-reference/evaluators/delete_evaluator.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ print(response.text)
<ResponseExample>

```json 200
{}
{
"info": "Evaluator deleted successfully!"
}
```

```json 422
Expand Down
8 changes: 7 additions & 1 deletion api-reference/evaluators/get_evaluator.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,13 @@ print(response.text)
<ResponseExample>

```json 200
{}
{
"class_config": "...",
"client_side": "false",
"eval_name": "evaluator",
"judge_models": "claude-3.5-sonnet@aws-bedrock",
"system_prompt": "..."
}
```

```json 422
Expand Down
6 changes: 5 additions & 1 deletion api-reference/evaluators/list_evaluators.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,11 @@ print(response.text)
<ResponseExample>

```json 200
{}
[
"evaluator_a",
"evaluator_b",
"evaluator_c"
]
```

</ResponseExample>
4 changes: 3 additions & 1 deletion api-reference/evaluators/rename_evaluator.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@ print(response.text)
<ResponseExample>

```json 200
{}
{
"info": "Evaluator renamed successfully!"
}
```

```json 422
Expand Down
71 changes: 62 additions & 9 deletions api-reference/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
]
}
}
}
Expand Down Expand Up @@ -1325,7 +1335,10 @@
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
"schema": {},
"example": {
"info": "Evaluator created successfully!"
}
}
}
},
Expand Down Expand Up @@ -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": "..."
}
}
}
},
Expand Down Expand Up @@ -1419,7 +1439,10 @@
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
"schema": {},
"example": {
"info": "Evaluator deleted successfully!"
}
}
}
},
Expand Down Expand Up @@ -1480,7 +1503,10 @@
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
"schema": {},
"example": {
"info": "Evaluator renamed successfully!"
}
}
}
},
Expand Down Expand Up @@ -1510,7 +1536,12 @@
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
"schema": {},
"example": [
"evaluator_a",
"evaluator_b",
"evaluator_c"
]
}
}
}
Expand Down Expand Up @@ -1779,7 +1810,10 @@
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
"schema": {},
"example": {
"info": "Evaluation deleted successfully!"
}
}
}
},
Expand Down Expand Up @@ -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
}
}
}
}
}
},
Expand Down Expand Up @@ -2130,7 +2180,10 @@
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
"schema": {},
"example": {
"info": "Benchmark deleted successfully!"
}
}
}
},
Expand Down

0 comments on commit aba8a41

Please sign in to comment.