Skip to content

Commit abd4236

Browse files
authored
Update type shape for evals.create
1 parent 42714c1 commit abd4236

1 file changed

Lines changed: 91 additions & 84 deletions

File tree

openapi.yaml

Lines changed: 91 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -7722,102 +7722,109 @@ components:
77227722
description: 'Current status of the batch job'
77237723

77247724
EvaluationTypedRequest:
7725-
type: object
7726-
required:
7727-
- type
7728-
- parameters
7729-
properties:
7730-
type:
7731-
type: string
7732-
enum: [classify, score, compare]
7733-
description: The type of evaluation to perform
7734-
example: 'classify'
7735-
parameters:
7736-
oneOf:
7737-
- $ref: '#/components/schemas/EvaluationClassifyParameters'
7738-
- $ref: '#/components/schemas/EvaluationScoreParameters'
7739-
- $ref: '#/components/schemas/EvaluationCompareParameters'
7740-
description: Type-specific parameters for the evaluation
7725+
description: Type-specific parameters for the evaluation
7726+
oneOf:
7727+
- $ref: '#/components/schemas/EvaluationClassifyParameters'
7728+
- $ref: '#/components/schemas/EvaluationScoreParameters'
7729+
- $ref: '#/components/schemas/EvaluationCompareParameters'
77417730

77427731
EvaluationClassifyParameters:
77437732
type: object
7744-
required:
7745-
- judge
7746-
- labels
7747-
- pass_labels
7748-
- input_data_file_path
7733+
required: ['type', 'parameters']
77497734
properties:
7750-
judge:
7751-
$ref: '#/components/schemas/EvaluationJudgeModelConfig'
7752-
labels:
7753-
type: array
7754-
items:
7755-
type: string
7756-
minItems: 2
7757-
description: List of possible classification labels
7758-
example: ['yes', 'no']
7759-
pass_labels:
7760-
type: array
7761-
items:
7762-
type: string
7763-
minItems: 1
7764-
description: List of labels that are considered passing
7765-
example: ['yes']
7766-
model_to_evaluate:
7767-
$ref: '#/components/schemas/EvaluationModelOrString'
7768-
input_data_file_path:
7769-
type: string
7770-
description: Data file ID
7771-
example: 'file-1234-aefd'
7735+
type:
7736+
const: classify
7737+
parameters:
7738+
type: object
7739+
required:
7740+
- judge
7741+
- labels
7742+
- pass_labels
7743+
- input_data_file_path
7744+
properties:
7745+
judge:
7746+
$ref: '#/components/schemas/EvaluationJudgeModelConfig'
7747+
labels:
7748+
type: array
7749+
items:
7750+
type: string
7751+
minItems: 2
7752+
description: List of possible classification labels
7753+
example: ['yes', 'no']
7754+
pass_labels:
7755+
type: array
7756+
items:
7757+
type: string
7758+
minItems: 1
7759+
description: List of labels that are considered passing
7760+
example: ['yes']
7761+
model_to_evaluate:
7762+
$ref: '#/components/schemas/EvaluationModelOrString'
7763+
input_data_file_path:
7764+
type: string
7765+
description: Data file ID
7766+
example: 'file-1234-aefd'
77727767

77737768
EvaluationScoreParameters:
77747769
type: object
7775-
required:
7776-
- judge
7777-
- min_score
7778-
- max_score
7779-
- pass_threshold
7780-
- input_data_file_path
7770+
required: ['type', 'parameters']
77817771
properties:
7782-
judge:
7783-
$ref: '#/components/schemas/EvaluationJudgeModelConfig'
7784-
min_score:
7785-
type: number
7786-
format: float
7787-
example: 0.0
7788-
description: Minimum possible score
7789-
max_score:
7790-
type: number
7791-
format: float
7792-
example: 10.0
7793-
description: Maximum possible score
7794-
pass_threshold:
7795-
type: number
7796-
format: float
7797-
example: 7.0
7798-
description: Score threshold for passing
7799-
model_to_evaluate:
7800-
$ref: '#/components/schemas/EvaluationModelOrString'
7801-
input_data_file_path:
7802-
type: string
7803-
example: 'file-01234567890123456789'
7804-
description: Data file ID
7772+
type:
7773+
const: score
7774+
parameters:
7775+
type: object
7776+
required:
7777+
- judge
7778+
- min_score
7779+
- max_score
7780+
- pass_threshold
7781+
- input_data_file_path
7782+
properties:
7783+
judge:
7784+
$ref: '#/components/schemas/EvaluationJudgeModelConfig'
7785+
min_score:
7786+
type: number
7787+
format: float
7788+
example: 0.0
7789+
description: Minimum possible score
7790+
max_score:
7791+
type: number
7792+
format: float
7793+
example: 10.0
7794+
description: Maximum possible score
7795+
pass_threshold:
7796+
type: number
7797+
format: float
7798+
example: 7.0
7799+
description: Score threshold for passing
7800+
model_to_evaluate:
7801+
$ref: '#/components/schemas/EvaluationModelOrString'
7802+
input_data_file_path:
7803+
type: string
7804+
example: 'file-01234567890123456789'
7805+
description: Data file ID
78057806

78067807
EvaluationCompareParameters:
78077808
type: object
7808-
required:
7809-
- judge
7810-
- input_data_file_path
7809+
required: ['type', 'parameters']
78117810
properties:
7812-
judge:
7813-
$ref: '#/components/schemas/EvaluationJudgeModelConfig'
7814-
model_a:
7815-
$ref: '#/components/schemas/EvaluationModelOrString'
7816-
model_b:
7817-
$ref: '#/components/schemas/EvaluationModelOrString'
7818-
input_data_file_path:
7819-
type: string
7820-
description: Data file name
7811+
type:
7812+
const: compare
7813+
parameters:
7814+
type: object
7815+
required:
7816+
- judge
7817+
- input_data_file_path
7818+
properties:
7819+
judge:
7820+
$ref: '#/components/schemas/EvaluationJudgeModelConfig'
7821+
model_a:
7822+
$ref: '#/components/schemas/EvaluationModelOrString'
7823+
model_b:
7824+
$ref: '#/components/schemas/EvaluationModelOrString'
7825+
input_data_file_path:
7826+
type: string
7827+
description: Data file name
78217828

78227829
EvaluationJudgeModelConfig:
78237830
type: object

0 commit comments

Comments
 (0)