Skip to content

Commit eda392e

Browse files
dkampasiharshmaru7
andauthored
Document model evaluation preset list and get endpoints. (#1176)
Adds public API docs for listing and retrieving saved model evaluation presets. Co-authored-by: Harsh Maru <38807407+harshmaru7@users.noreply.github.com>
1 parent 4611f91 commit eda392e

5 files changed

Lines changed: 96 additions & 0 deletions

File tree

specification/DigitalOcean-public.v2.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2789,6 +2789,14 @@ paths:
27892789
$ref: 'resources/gen-ai/genai_list_model_evaluation_metrics.yml'
27902790

27912791

2792+
/v2/gen-ai/model_evaluation_presets:
2793+
get:
2794+
$ref: 'resources/gen-ai/genai_list_model_evaluation_presets.yml'
2795+
2796+
2797+
/v2/gen-ai/model_evaluation_presets/{eval_preset_uuid}:
2798+
get:
2799+
$ref: 'resources/gen-ai/genai_get_model_evaluation_preset.yml'
27922800

27932801

27942802
/v2/gen-ai/model_evaluation_runs:
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
lang: cURL
2+
source: |-
3+
curl -X GET \
4+
-H "Content-Type: application/json" \
5+
-H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
6+
"https://api.digitalocean.com/v2/gen-ai/model_evaluation_presets/123e4567-e89b-12d3-a456-426614174000"
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
lang: cURL
2+
source: |-
3+
curl -X GET \
4+
-H "Content-Type: application/json" \
5+
-H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
6+
"https://api.digitalocean.com/v2/gen-ai/model_evaluation_presets"
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
description: To retrieve a saved model evaluation preset, send a GET request to `/v2/genai/model_evaluation_presets/{eval_preset_uuid}`.
2+
operationId: genai_get_model_evaluation_preset
3+
parameters:
4+
- description: UUID of the evaluation preset.
5+
example: '"123e4567-e89b-12d3-a456-426614174000"'
6+
in: path
7+
name: eval_preset_uuid
8+
required: true
9+
schema:
10+
type: string
11+
responses:
12+
"200":
13+
content:
14+
application/json:
15+
schema:
16+
$ref: ./definitions.yml#/apiGetModelEvaluationPresetOutput
17+
description: A successful response.
18+
headers:
19+
ratelimit-limit:
20+
$ref: ../../shared/headers.yml#/ratelimit-limit
21+
ratelimit-remaining:
22+
$ref: ../../shared/headers.yml#/ratelimit-remaining
23+
ratelimit-reset:
24+
$ref: ../../shared/headers.yml#/ratelimit-reset
25+
"401":
26+
$ref: ../../shared/responses/unauthorized.yml
27+
"404":
28+
$ref: ../../shared/responses/not_found.yml
29+
"429":
30+
$ref: ../../shared/responses/too_many_requests.yml
31+
"500":
32+
$ref: ../../shared/responses/server_error.yml
33+
default:
34+
$ref: ../../shared/responses/unexpected_error.yml
35+
security:
36+
- bearer_auth:
37+
- genai:read
38+
summary: Retrieve Model Evaluation Preset
39+
tags:
40+
- GradientAI Platform
41+
x-codeSamples:
42+
- $ref: examples/curl/genai_get_model_evaluation_preset.yml
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
description: To list all saved model evaluation presets, send a GET request to `/v2/genai/model_evaluation_presets`.
2+
operationId: genai_list_model_evaluation_presets
3+
responses:
4+
"200":
5+
content:
6+
application/json:
7+
schema:
8+
$ref: ./definitions.yml#/apiListModelEvaluationPresetsOutput
9+
description: A successful response.
10+
headers:
11+
ratelimit-limit:
12+
$ref: ../../shared/headers.yml#/ratelimit-limit
13+
ratelimit-remaining:
14+
$ref: ../../shared/headers.yml#/ratelimit-remaining
15+
ratelimit-reset:
16+
$ref: ../../shared/headers.yml#/ratelimit-reset
17+
"401":
18+
$ref: ../../shared/responses/unauthorized.yml
19+
"404":
20+
$ref: ../../shared/responses/not_found.yml
21+
"429":
22+
$ref: ../../shared/responses/too_many_requests.yml
23+
"500":
24+
$ref: ../../shared/responses/server_error.yml
25+
default:
26+
$ref: ../../shared/responses/unexpected_error.yml
27+
security:
28+
- bearer_auth:
29+
- genai:read
30+
summary: List Model Evaluation Presets
31+
tags:
32+
- GradientAI Platform
33+
x-codeSamples:
34+
- $ref: examples/curl/genai_list_model_evaluation_presets.yml

0 commit comments

Comments
 (0)