Python 88.3%
TypeScript 7.6%
Shell 4.1%
1[2 {3 "provider": "openai",4 "api_family": "files",5 "name": "File",6 "spec_schema": "OpenAIFile",7 "object_type": "file",8 "description": "The `File` object represents a document that has been uploaded to OpenAI.",9 "required": [10 "id",11 "object",12 "bytes",13 "created_at",14 "filename",15 "purpose",16 "status"17 ],18 "fields": [19 {20 "parameter": "id",21 "type": "string",22 "required": true,23 "description": "The file identifier, which can be referenced in the API endpoints."24 },25 {26 "parameter": "bytes",27 "type": "integer",28 "required": true,29 "description": "The size of the file, in bytes."30 },31 {32 "parameter": "created_at",33 "type": "integer",34 "required": true,35 "description": "The Unix timestamp (in seconds) for when the file was created."36 },37 {38 "parameter": "expires_at",39 "type": "integer",40 "description": "The Unix timestamp (in seconds) for when the file will expire."41 },42 {43 "parameter": "filename",44 "type": "string",45 "required": true,46 "description": "The name of the file."47 },48 {49 "parameter": "object",50 "type": "string",51 "required": true,52 "enum": [53 "file"54 ],55 "description": "The object type, which is always `file`."56 },57 {58 "parameter": "purpose",59 "type": "string",60 "required": true,61 "enum": [62 "assistants",63 "assistants_output",64 "batch",65 "batch_output",66 "fine-tune",67 "fine-tune-results",68 "vision",69 "user_data"70 ],71 "description": "The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `vision`, and `user_data`."72 },73 {74 "parameter": "status",75 "type": "string",76 "required": true,77 "enum": [78 "uploaded",79 "processed",80 "error"81 ],82 "description": "Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`."83 },84 {85 "parameter": "status_details",86 "type": "string",87 "description": "Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`."88 }89 ],90 "status": [91 "DOCUMENTED"92 ],93 "verification": {94 "method": "docs_only"95 },96 "sources": [97 {98 "url": "https://developers.openai.com/api/reference/resources/files",99 "retrieved_at": "2026-09-18"100 },101 {102 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",103 "retrieved_at": "2026-09-18"104 }105 ]106 },107 {108 "provider": "openai",109 "api_family": "uploads",110 "name": "Upload",111 "spec_schema": "Upload",112 "object_type": "upload",113 "description": "The Upload object can accept byte chunks in the form of Parts.",114 "required": [115 "bytes",116 "created_at",117 "expires_at",118 "filename",119 "id",120 "purpose",121 "status"122 ],123 "fields": [124 {125 "parameter": "id",126 "type": "string",127 "required": true,128 "description": "The Upload unique identifier, which can be referenced in API endpoints."129 },130 {131 "parameter": "created_at",132 "type": "integer",133 "required": true,134 "description": "The Unix timestamp (in seconds) for when the Upload was created."135 },136 {137 "parameter": "filename",138 "type": "string",139 "required": true,140 "description": "The name of the file to be uploaded."141 },142 {143 "parameter": "bytes",144 "type": "integer",145 "required": true,146 "description": "The intended number of bytes to be uploaded."147 },148 {149 "parameter": "purpose",150 "type": "string",151 "required": true,152 "description": "The intended purpose of the file. [Please refer here](https://developers.openai.com/api/reference/resources/files#%28resource%29%20files%20%3E%20%28model%29%20file_object%20%3E%20%28schema%29%20%3E%20%28property%29%20purpose) for acceptable values."153 },154 {155 "parameter": "status",156 "type": "string",157 "required": true,158 "enum": [159 "pending",160 "completed",161 "cancelled",162 "expired"163 ],164 "description": "The status of the Upload."165 },166 {167 "parameter": "expires_at",168 "type": "integer",169 "required": true,170 "description": "The Unix timestamp (in seconds) for when the Upload will expire."171 },172 {173 "parameter": "object",174 "type": "string",175 "enum": [176 "upload"177 ],178 "description": "The object type, which is always \"upload\"."179 },180 {181 "parameter": "file",182 "type": "object",183 "description": ""184 },185 {186 "parameter": "file.id",187 "type": "string",188 "required": true,189 "description": "The file identifier, which can be referenced in the API endpoints."190 },191 {192 "parameter": "file.bytes",193 "type": "integer",194 "required": true,195 "description": "The size of the file, in bytes."196 },197 {198 "parameter": "file.created_at",199 "type": "integer",200 "required": true,201 "description": "The Unix timestamp (in seconds) for when the file was created."202 },203 {204 "parameter": "file.expires_at",205 "type": "integer",206 "description": "The Unix timestamp (in seconds) for when the file will expire."207 },208 {209 "parameter": "file.filename",210 "type": "string",211 "required": true,212 "description": "The name of the file."213 },214 {215 "parameter": "file.object",216 "type": "string",217 "required": true,218 "enum": [219 "file"220 ],221 "description": "The object type, which is always `file`."222 },223 {224 "parameter": "file.purpose",225 "type": "string",226 "required": true,227 "enum": [228 "assistants",229 "assistants_output",230 "batch",231 "batch_output",232 "fine-tune",233 "fine-tune-results",234 "vision",235 "user_data"236 ],237 "description": "The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `vision`, and `user_data`."238 },239 {240 "parameter": "file.status",241 "type": "string",242 "required": true,243 "enum": [244 "uploaded",245 "processed",246 "error"247 ],248 "description": "Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`."249 },250 {251 "parameter": "file.status_details",252 "type": "string",253 "description": "Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`."254 }255 ],256 "status": [257 "DOCUMENTED"258 ],259 "verification": {260 "method": "docs_only"261 },262 "sources": [263 {264 "url": "https://developers.openai.com/api/reference/resources/uploads",265 "retrieved_at": "2026-09-18"266 },267 {268 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",269 "retrieved_at": "2026-09-18"270 }271 ]272 },273 {274 "provider": "openai",275 "api_family": "uploads",276 "name": "UploadPart",277 "spec_schema": "UploadPart",278 "object_type": "upload.part",279 "description": "The upload Part represents a chunk of bytes we can add to an Upload object.",280 "required": [281 "created_at",282 "id",283 "object",284 "upload_id"285 ],286 "fields": [287 {288 "parameter": "id",289 "type": "string",290 "required": true,291 "description": "The upload Part unique identifier, which can be referenced in API endpoints."292 },293 {294 "parameter": "created_at",295 "type": "integer",296 "required": true,297 "description": "The Unix timestamp (in seconds) for when the Part was created."298 },299 {300 "parameter": "upload_id",301 "type": "string",302 "required": true,303 "description": "The ID of the Upload object that this Part was added to."304 },305 {306 "parameter": "object",307 "type": "string",308 "required": true,309 "enum": [310 "upload.part"311 ],312 "description": "The object type, which is always `upload.part`."313 }314 ],315 "status": [316 "DOCUMENTED"317 ],318 "verification": {319 "method": "docs_only"320 },321 "sources": [322 {323 "url": "https://developers.openai.com/api/reference/resources/uploads",324 "retrieved_at": "2026-09-18"325 },326 {327 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",328 "retrieved_at": "2026-09-18"329 }330 ]331 },332 {333 "provider": "openai",334 "api_family": "vector_stores",335 "name": "VectorStore",336 "spec_schema": "VectorStoreObject",337 "object_type": "vector_store",338 "description": "A vector store is a collection of processed files can be used by the `file_search` tool.",339 "required": [340 "id",341 "object",342 "usage_bytes",343 "created_at",344 "status",345 "last_active_at",346 "name",347 "file_counts",348 "metadata"349 ],350 "fields": [351 {352 "parameter": "id",353 "type": "string",354 "required": true,355 "description": "The identifier, which can be referenced in API endpoints."356 },357 {358 "parameter": "object",359 "type": "string",360 "required": true,361 "enum": [362 "vector_store"363 ],364 "description": "The object type, which is always `vector_store`."365 },366 {367 "parameter": "created_at",368 "type": "integer",369 "required": true,370 "description": "The Unix timestamp (in seconds) for when the vector store was created."371 },372 {373 "parameter": "name",374 "type": "string",375 "required": true,376 "description": "The name of the vector store."377 },378 {379 "parameter": "usage_bytes",380 "type": "integer",381 "required": true,382 "description": "The total number of bytes used by the files in the vector store."383 },384 {385 "parameter": "file_counts",386 "type": "object",387 "required": true,388 "description": ""389 },390 {391 "parameter": "file_counts.in_progress",392 "type": "integer",393 "required": true,394 "description": "The number of files that are currently being processed."395 },396 {397 "parameter": "file_counts.completed",398 "type": "integer",399 "required": true,400 "description": "The number of files that have been successfully processed."401 },402 {403 "parameter": "file_counts.failed",404 "type": "integer",405 "required": true,406 "description": "The number of files that have failed to process."407 },408 {409 "parameter": "file_counts.cancelled",410 "type": "integer",411 "required": true,412 "description": "The number of files that were cancelled."413 },414 {415 "parameter": "file_counts.total",416 "type": "integer",417 "required": true,418 "description": "The total number of files."419 },420 {421 "parameter": "status",422 "type": "string",423 "required": true,424 "enum": [425 "expired",426 "in_progress",427 "completed"428 ],429 "description": "The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use."430 },431 {432 "parameter": "expires_after",433 "type": "object",434 "description": "The expiration policy for a vector store."435 },436 {437 "parameter": "expires_after.anchor",438 "type": "string",439 "required": true,440 "enum": [441 "last_active_at"442 ],443 "description": "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`."444 },445 {446 "parameter": "expires_after.days",447 "type": "integer",448 "required": true,449 "minimum": 1,450 "maximum": 365,451 "description": "The number of days after the anchor time that the vector store will expire."452 },453 {454 "parameter": "expires_at",455 "type": "integer | null",456 "description": ""457 },458 {459 "parameter": "last_active_at",460 "type": "integer | null",461 "required": true,462 "description": ""463 },464 {465 "parameter": "metadata",466 "type": "object | null",467 "required": true,468 "description": ""469 }470 ],471 "status": [472 "DOCUMENTED"473 ],474 "verification": {475 "method": "docs_only"476 },477 "sources": [478 {479 "url": "https://developers.openai.com/api/reference/resources/vector_stores",480 "retrieved_at": "2026-09-18"481 },482 {483 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",484 "retrieved_at": "2026-09-18"485 }486 ]487 },488 {489 "provider": "openai",490 "api_family": "vector_stores",491 "name": "VectorStoreFile",492 "spec_schema": "VectorStoreFileObject",493 "object_type": "vector_store.file",494 "description": "A list of files attached to a vector store.",495 "required": [496 "id",497 "object",498 "usage_bytes",499 "created_at",500 "vector_store_id",501 "status",502 "last_error"503 ],504 "fields": [505 {506 "parameter": "id",507 "type": "string",508 "required": true,509 "description": "The identifier, which can be referenced in API endpoints."510 },511 {512 "parameter": "object",513 "type": "string",514 "required": true,515 "enum": [516 "vector_store.file"517 ],518 "description": "The object type, which is always `vector_store.file`."519 },520 {521 "parameter": "usage_bytes",522 "type": "integer",523 "required": true,524 "description": "The total vector store usage in bytes. Note that this may be different from the original file size."525 },526 {527 "parameter": "created_at",528 "type": "integer",529 "required": true,530 "description": "The Unix timestamp (in seconds) for when the vector store file was created."531 },532 {533 "parameter": "vector_store_id",534 "type": "string",535 "required": true,536 "description": "The ID of the [vector store](https://developers.openai.com/api/reference/resources/vector_stores) that the [File](https://developers.openai.com/api/reference/resources/files) is attached to."537 },538 {539 "parameter": "status",540 "type": "string",541 "required": true,542 "enum": [543 "in_progress",544 "completed",545 "cancelled",546 "failed"547 ],548 "description": "The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use."549 },550 {551 "parameter": "last_error",552 "type": "object | null",553 "required": true,554 "description": ""555 },556 {557 "parameter": "last_error.code",558 "type": "string",559 "required": true,560 "enum": [561 "server_error",562 "unsupported_file",563 "invalid_file"564 ],565 "description": "One of `server_error`, `unsupported_file`, or `invalid_file`."566 },567 {568 "parameter": "last_error.message",569 "type": "string",570 "required": true,571 "description": "A human-readable description of the error."572 },573 {574 "parameter": "chunking_strategy",575 "type": "object",576 "description": "The strategy used to chunk the file."577 },578 {579 "parameter": "chunking_strategy.type",580 "type": "string",581 "required": true,582 "enum": [583 "static"584 ],585 "description": "Always `static`."586 },587 {588 "parameter": "chunking_strategy.static",589 "type": "object",590 "required": true,591 "description": ""592 },593 {594 "parameter": "chunking_strategy.static.max_chunk_size_tokens",595 "type": "integer",596 "required": true,597 "minimum": 100,598 "maximum": 4096,599 "description": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`."600 },601 {602 "parameter": "chunking_strategy.static.chunk_overlap_tokens",603 "type": "integer",604 "required": true,605 "description": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`."606 },607 {608 "parameter": "chunking_strategy.type",609 "type": "string",610 "required": true,611 "enum": [612 "other"613 ],614 "description": "Always `other`."615 },616 {617 "parameter": "attributes",618 "type": "object | null",619 "description": ""620 }621 ],622 "status": [623 "DOCUMENTED"624 ],625 "verification": {626 "method": "docs_only"627 },628 "sources": [629 {630 "url": "https://developers.openai.com/api/reference/resources/vector_stores",631 "retrieved_at": "2026-09-18"632 },633 {634 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",635 "retrieved_at": "2026-09-18"636 }637 ]638 },639 {640 "provider": "openai",641 "api_family": "vector_stores",642 "name": "VectorStoreFileBatch",643 "spec_schema": "VectorStoreFileBatchObject",644 "object_type": "vector_store.files_batch",645 "description": "A batch of files attached to a vector store.",646 "required": [647 "id",648 "object",649 "created_at",650 "vector_store_id",651 "status",652 "file_counts"653 ],654 "fields": [655 {656 "parameter": "id",657 "type": "string",658 "required": true,659 "description": "The identifier, which can be referenced in API endpoints."660 },661 {662 "parameter": "object",663 "type": "string",664 "required": true,665 "enum": [666 "vector_store.files_batch"667 ],668 "description": "The object type, which is always `vector_store.file_batch`."669 },670 {671 "parameter": "created_at",672 "type": "integer",673 "required": true,674 "description": "The Unix timestamp (in seconds) for when the vector store files batch was created."675 },676 {677 "parameter": "vector_store_id",678 "type": "string",679 "required": true,680 "description": "The ID of the [vector store](https://developers.openai.com/api/reference/resources/vector_stores) that the [File](https://developers.openai.com/api/reference/resources/files) is attached to."681 },682 {683 "parameter": "status",684 "type": "string",685 "required": true,686 "enum": [687 "in_progress",688 "completed",689 "cancelled",690 "failed"691 ],692 "description": "The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`."693 },694 {695 "parameter": "file_counts",696 "type": "object",697 "required": true,698 "description": ""699 },700 {701 "parameter": "file_counts.in_progress",702 "type": "integer",703 "required": true,704 "description": "The number of files that are currently being processed."705 },706 {707 "parameter": "file_counts.completed",708 "type": "integer",709 "required": true,710 "description": "The number of files that have been processed."711 },712 {713 "parameter": "file_counts.failed",714 "type": "integer",715 "required": true,716 "description": "The number of files that have failed to process."717 },718 {719 "parameter": "file_counts.cancelled",720 "type": "integer",721 "required": true,722 "description": "The number of files that where cancelled."723 },724 {725 "parameter": "file_counts.total",726 "type": "integer",727 "required": true,728 "description": "The total number of files."729 }730 ],731 "status": [732 "DOCUMENTED"733 ],734 "verification": {735 "method": "docs_only"736 },737 "sources": [738 {739 "url": "https://developers.openai.com/api/reference/resources/vector_stores",740 "retrieved_at": "2026-09-18"741 },742 {743 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",744 "retrieved_at": "2026-09-18"745 }746 ]747 },748 {749 "provider": "openai",750 "api_family": "vector_stores",751 "name": "VectorStoreSearchResultsPage",752 "spec_schema": "VectorStoreSearchResultsPage",753 "object_type": "vector_store.search_results.page",754 "description": "",755 "required": [756 "object",757 "search_query",758 "data",759 "has_more",760 "next_page"761 ],762 "fields": [763 {764 "parameter": "object",765 "type": "string",766 "required": true,767 "enum": [768 "vector_store.search_results.page"769 ],770 "description": "The object type, which is always `vector_store.search_results.page`"771 },772 {773 "parameter": "search_query",774 "type": "array<string>",775 "required": true,776 "description": ""777 },778 {779 "parameter": "data",780 "type": "array<object>",781 "required": true,782 "description": "The list of search result items."783 },784 {785 "parameter": "data[].file_id",786 "type": "string",787 "required": true,788 "description": "The ID of the vector store file."789 },790 {791 "parameter": "data[].filename",792 "type": "string",793 "required": true,794 "description": "The name of the vector store file."795 },796 {797 "parameter": "data[].score",798 "type": "number",799 "required": true,800 "maximum": 1,801 "description": "The similarity score for the result."802 },803 {804 "parameter": "data[].attributes",805 "type": "object | null",806 "required": true,807 "description": ""808 },809 {810 "parameter": "data[].content",811 "type": "array<object>",812 "required": true,813 "description": "Content chunks from the file."814 },815 {816 "parameter": "data[].content[].type",817 "type": "string",818 "required": true,819 "enum": [820 "text"821 ],822 "description": "The type of content."823 },824 {825 "parameter": "data[].content[].text",826 "type": "string",827 "required": true,828 "description": "The text content returned from search."829 },830 {831 "parameter": "has_more",832 "type": "boolean",833 "required": true,834 "description": "Indicates if there are more results to fetch."835 },836 {837 "parameter": "next_page",838 "type": "string | null",839 "required": true,840 "description": ""841 }842 ],843 "status": [844 "DOCUMENTED"845 ],846 "verification": {847 "method": "docs_only"848 },849 "sources": [850 {851 "url": "https://developers.openai.com/api/reference/resources/vector_stores",852 "retrieved_at": "2026-09-18"853 },854 {855 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",856 "retrieved_at": "2026-09-18"857 }858 ]859 },860 {861 "provider": "openai",862 "api_family": "vector_stores",863 "name": "VectorStoreFileContentPage",864 "spec_schema": "VectorStoreFileContentResponse",865 "object_type": "vector_store.file_content.page",866 "description": "Represents the parsed content of a vector store file.",867 "required": [868 "object",869 "data",870 "has_more",871 "next_page"872 ],873 "fields": [874 {875 "parameter": "object",876 "type": "string",877 "required": true,878 "enum": [879 "vector_store.file_content.page"880 ],881 "description": "The object type, which is always `vector_store.file_content.page`"882 },883 {884 "parameter": "data",885 "type": "array<object>",886 "required": true,887 "description": "Parsed content of the file."888 },889 {890 "parameter": "data[].type",891 "type": "string",892 "description": "The content type (currently only `\"text\"`)"893 },894 {895 "parameter": "data[].text",896 "type": "string",897 "description": "The text content"898 },899 {900 "parameter": "has_more",901 "type": "boolean",902 "required": true,903 "description": "Indicates if there are more content pages to fetch."904 },905 {906 "parameter": "next_page",907 "type": "string | null",908 "required": true,909 "description": ""910 }911 ],912 "status": [913 "DOCUMENTED"914 ],915 "verification": {916 "method": "docs_only"917 },918 "sources": [919 {920 "url": "https://developers.openai.com/api/reference/resources/vector_stores",921 "retrieved_at": "2026-09-18"922 },923 {924 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",925 "retrieved_at": "2026-09-18"926 }927 ]928 },929 {930 "provider": "openai",931 "api_family": "batches",932 "name": "Batch",933 "spec_schema": "Batch",934 "object_type": "batch",935 "description": "",936 "required": [937 "id",938 "object",939 "endpoint",940 "input_file_id",941 "completion_window",942 "status",943 "created_at"944 ],945 "fields": [946 {947 "parameter": "id",948 "type": "string",949 "required": true,950 "description": ""951 },952 {953 "parameter": "object",954 "type": "string",955 "required": true,956 "enum": [957 "batch"958 ],959 "description": "The object type, which is always `batch`."960 },961 {962 "parameter": "endpoint",963 "type": "string",964 "required": true,965 "description": "The OpenAI API endpoint used by the batch."966 },967 {968 "parameter": "model",969 "type": "string",970 "description": "Model ID used to process the batch, like `gpt-6-astra`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model\nguide](https://developers.openai.com/api/docs/models) to browse and compare available models."971 },972 {973 "parameter": "errors",974 "type": "object",975 "description": ""976 },977 {978 "parameter": "errors.object",979 "type": "string",980 "description": "The object type, which is always `list`."981 },982 {983 "parameter": "errors.data",984 "type": "array<object>",985 "description": ""986 },987 {988 "parameter": "errors.data[].code",989 "type": "string",990 "description": "An error code identifying the error type."991 },992 {993 "parameter": "errors.data[].message",994 "type": "string",995 "description": "A human-readable message providing more details about the error."996 },997 {998 "parameter": "errors.data[].param",999 "type": "string | null",1000 "description": ""1001 },1002 {1003 "parameter": "errors.data[].line",1004 "type": "integer | null",1005 "description": ""1006 },1007 {1008 "parameter": "input_file_id",1009 "type": "string",1010 "required": true,1011 "description": "The ID of the input file for the batch."1012 },1013 {1014 "parameter": "completion_window",1015 "type": "string",1016 "required": true,1017 "description": "The time frame within which the batch should be processed."1018 },1019 {1020 "parameter": "status",1021 "type": "string",1022 "required": true,1023 "enum": [1024 "validating",1025 "failed",1026 "in_progress",1027 "finalizing",1028 "completed",1029 "expired",1030 "cancelling",1031 "cancelled"1032 ],1033 "description": "The current status of the batch."1034 },1035 {1036 "parameter": "output_file_id",1037 "type": "string",1038 "description": "The ID of the file containing the outputs of successfully executed requests."1039 },1040 {1041 "parameter": "error_file_id",1042 "type": "string",1043 "description": "The ID of the file containing the outputs of requests with errors."1044 },1045 {1046 "parameter": "created_at",1047 "type": "integer",1048 "required": true,1049 "description": "The Unix timestamp (in seconds) for when the batch was created."1050 },1051 {1052 "parameter": "in_progress_at",1053 "type": "integer",1054 "description": "The Unix timestamp (in seconds) for when the batch started processing."1055 },1056 {1057 "parameter": "expires_at",1058 "type": "integer",1059 "description": "The Unix timestamp (in seconds) for when the batch will expire."1060 },1061 {1062 "parameter": "finalizing_at",1063 "type": "integer",1064 "description": "The Unix timestamp (in seconds) for when the batch started finalizing."1065 },1066 {1067 "parameter": "completed_at",1068 "type": "integer",1069 "description": "The Unix timestamp (in seconds) for when the batch was completed."1070 },1071 {1072 "parameter": "failed_at",1073 "type": "integer",1074 "description": "The Unix timestamp (in seconds) for when the batch failed."1075 },1076 {1077 "parameter": "expired_at",1078 "type": "integer",1079 "description": "The Unix timestamp (in seconds) for when the batch expired."1080 },1081 {1082 "parameter": "cancelling_at",1083 "type": "integer",1084 "description": "The Unix timestamp (in seconds) for when the batch started cancelling."1085 },1086 {1087 "parameter": "cancelled_at",1088 "type": "integer",1089 "description": "The Unix timestamp (in seconds) for when the batch was cancelled."1090 },1091 {1092 "parameter": "request_counts",1093 "type": "object",1094 "description": "The request counts for different statuses within the batch."1095 },1096 {1097 "parameter": "request_counts.total",1098 "type": "integer",1099 "required": true,1100 "description": "Total number of requests in the batch."1101 },1102 {1103 "parameter": "request_counts.completed",1104 "type": "integer",1105 "required": true,1106 "description": "Number of requests that have been completed successfully."1107 },1108 {1109 "parameter": "request_counts.failed",1110 "type": "integer",1111 "required": true,1112 "description": "Number of requests that have failed."1113 },1114 {1115 "parameter": "usage",1116 "type": "object",1117 "description": "Represents token usage details including input tokens, output tokens, a\nbreakdown of output tokens, and the total tokens used. Only populated on\nbatches created after September 7, 2025."1118 },1119 {1120 "parameter": "usage.input_tokens",1121 "type": "integer",1122 "required": true,1123 "description": "The number of input tokens."1124 },1125 {1126 "parameter": "usage.input_tokens_details",1127 "type": "object",1128 "required": true,1129 "description": "A detailed breakdown of the input tokens."1130 },1131 {1132 "parameter": "usage.input_tokens_details.cached_tokens",1133 "type": "integer",1134 "required": true,1135 "description": "The number of tokens that were retrieved from the cache. [More on\nprompt caching](https://developers.openai.com/api/docs/guides/prompt-caching)."1136 },1137 {1138 "parameter": "usage.output_tokens",1139 "type": "integer",1140 "required": true,1141 "description": "The number of output tokens."1142 },1143 {1144 "parameter": "usage.output_tokens_details",1145 "type": "object",1146 "required": true,1147 "description": "A detailed breakdown of the output tokens."1148 },1149 {1150 "parameter": "usage.output_tokens_details.reasoning_tokens",1151 "type": "integer",1152 "required": true,1153 "description": "The number of reasoning tokens."1154 },1155 {1156 "parameter": "usage.total_tokens",1157 "type": "integer",1158 "required": true,1159 "description": "The total number of tokens used."1160 },1161 {1162 "parameter": "metadata",1163 "type": "object | null",1164 "description": ""1165 }1166 ],1167 "status": [1168 "DOCUMENTED"1169 ],1170 "verification": {1171 "method": "docs_only"1172 },1173 "sources": [1174 {1175 "url": "https://developers.openai.com/api/reference/resources/batches",1176 "retrieved_at": "2026-09-18"1177 },1178 {1179 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",1180 "retrieved_at": "2026-09-18"1181 }1182 ]1183 },1184 {1185 "provider": "openai",1186 "api_family": "batches",1187 "name": "BatchRequestCounts",1188 "spec_schema": "BatchRequestCounts",1189 "object_type": null,1190 "description": "The request counts for different statuses within the batch.",1191 "required": [1192 "total",1193 "completed",1194 "failed"1195 ],1196 "fields": [1197 {1198 "parameter": "total",1199 "type": "integer",1200 "required": true,1201 "description": "Total number of requests in the batch."1202 },1203 {1204 "parameter": "completed",1205 "type": "integer",1206 "required": true,1207 "description": "Number of requests that have been completed successfully."1208 },1209 {1210 "parameter": "failed",1211 "type": "integer",1212 "required": true,1213 "description": "Number of requests that have failed."1214 }1215 ],1216 "status": [1217 "DOCUMENTED"1218 ],1219 "verification": {1220 "method": "docs_only"1221 },1222 "sources": [1223 {1224 "url": "https://developers.openai.com/api/reference/resources/batches",1225 "retrieved_at": "2026-09-18"1226 },1227 {1228 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",1229 "retrieved_at": "2026-09-18"1230 }1231 ]1232 },1233 {1234 "provider": "openai",1235 "api_family": "batches",1236 "name": "BatchError",1237 "spec_schema": "BatchError",1238 "object_type": null,1239 "description": "",1240 "required": [],1241 "fields": [1242 {1243 "parameter": "code",1244 "type": "string",1245 "description": "An error code identifying the error type."1246 },1247 {1248 "parameter": "message",1249 "type": "string",1250 "description": "A human-readable message providing more details about the error."1251 },1252 {1253 "parameter": "param",1254 "type": "string | null",1255 "description": ""1256 },1257 {1258 "parameter": "line",1259 "type": "integer | null",1260 "description": ""1261 }1262 ],1263 "status": [1264 "DOCUMENTED"1265 ],1266 "verification": {1267 "method": "docs_only"1268 },1269 "sources": [1270 {1271 "url": "https://developers.openai.com/api/reference/resources/batches",1272 "retrieved_at": "2026-09-18"1273 },1274 {1275 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",1276 "retrieved_at": "2026-09-18"1277 }1278 ]1279 },1280 {1281 "provider": "openai",1282 "api_family": "fine_tuning",1283 "name": "FineTuningJob",1284 "spec_schema": "FineTuningJob",1285 "object_type": "fine_tuning.job",1286 "description": "The `fine_tuning.job` object represents a fine-tuning job that has been created through the API.",1287 "required": [1288 "created_at",1289 "error",1290 "finished_at",1291 "fine_tuned_model",1292 "hyperparameters",1293 "id",1294 "model",1295 "object",1296 "organization_id",1297 "result_files",1298 "status",1299 "trained_tokens",1300 "training_file",1301 "validation_file",1302 "seed"1303 ],1304 "fields": [1305 {1306 "parameter": "id",1307 "type": "string",1308 "required": true,1309 "description": "The object identifier, which can be referenced in the API endpoints."1310 },1311 {1312 "parameter": "created_at",1313 "type": "integer",1314 "required": true,1315 "description": "The Unix timestamp (in seconds) for when the fine-tuning job was created."1316 },1317 {1318 "parameter": "error",1319 "type": "object | null",1320 "required": true,1321 "description": ""1322 },1323 {1324 "parameter": "error.code",1325 "type": "string",1326 "required": true,1327 "description": "A machine-readable error code."1328 },1329 {1330 "parameter": "error.message",1331 "type": "string",1332 "required": true,1333 "description": "A human-readable error message."1334 },1335 {1336 "parameter": "error.param",1337 "type": "string | null",1338 "required": true,1339 "description": ""1340 },1341 {1342 "parameter": "fine_tuned_model",1343 "type": "string | null",1344 "required": true,1345 "description": ""1346 },1347 {1348 "parameter": "finished_at",1349 "type": "integer | null",1350 "required": true,1351 "description": ""1352 },1353 {1354 "parameter": "hyperparameters",1355 "type": "object",1356 "required": true,1357 "description": "The hyperparameters used for the fine-tuning job. This value will only be returned when running `supervised` jobs."1358 },1359 {1360 "parameter": "hyperparameters.batch_size",1361 "type": "object | null",1362 "description": ""1363 },1364 {1365 "parameter": "hyperparameters.learning_rate_multiplier",1366 "type": "string | number",1367 "default": "auto",1368 "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid\noverfitting."1369 },1370 {1371 "parameter": "hyperparameters.n_epochs",1372 "type": "string | integer",1373 "default": "auto",1374 "description": "The number of epochs to train the model for. An epoch refers to one full cycle\nthrough the training dataset."1375 },1376 {1377 "parameter": "model",1378 "type": "string",1379 "required": true,1380 "description": "The base model that is being fine-tuned."1381 },1382 {1383 "parameter": "object",1384 "type": "string",1385 "required": true,1386 "enum": [1387 "fine_tuning.job"1388 ],1389 "description": "The object type, which is always \"fine_tuning.job\"."1390 },1391 {1392 "parameter": "organization_id",1393 "type": "string",1394 "required": true,1395 "description": "The organization that owns the fine-tuning job."1396 },1397 {1398 "parameter": "result_files",1399 "type": "array<string>",1400 "required": true,1401 "description": "The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the [Files API](https://developers.openai.com/api/reference/resources/files/methods/content)."1402 },1403 {1404 "parameter": "status",1405 "type": "string",1406 "required": true,1407 "enum": [1408 "validating_files",1409 "queued",1410 "running",1411 "succeeded",1412 "failed",1413 "cancelled"1414 ],1415 "description": "The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`."1416 },1417 {1418 "parameter": "trained_tokens",1419 "type": "integer | null",1420 "required": true,1421 "description": ""1422 },1423 {1424 "parameter": "training_file",1425 "type": "string",1426 "required": true,1427 "description": "The file ID used for training. You can retrieve the training data with the [Files API](https://developers.openai.com/api/reference/resources/files/methods/content)."1428 },1429 {1430 "parameter": "validation_file",1431 "type": "string | null",1432 "required": true,1433 "description": ""1434 },1435 {1436 "parameter": "integrations",1437 "type": "array | null",1438 "description": ""1439 },1440 {1441 "parameter": "seed",1442 "type": "integer",1443 "required": true,1444 "description": "The seed used for the fine-tuning job."1445 },1446 {1447 "parameter": "estimated_finish",1448 "type": "integer | null",1449 "description": ""1450 },1451 {1452 "parameter": "method",1453 "type": "object",1454 "description": "The method used for fine-tuning."1455 },1456 {1457 "parameter": "method.type",1458 "type": "string",1459 "required": true,1460 "enum": [1461 "supervised",1462 "dpo",1463 "reinforcement"1464 ],1465 "description": "The type of method. Is either `supervised`, `dpo`, or `reinforcement`."1466 },1467 {1468 "parameter": "method.supervised",1469 "type": "object",1470 "description": "Configuration for the supervised fine-tuning method."1471 },1472 {1473 "parameter": "method.supervised.hyperparameters",1474 "type": "object",1475 "description": "The hyperparameters used for the fine-tuning job."1476 },1477 {1478 "parameter": "method.supervised.hyperparameters.batch_size",1479 "type": "string | integer",1480 "default": "auto",1481 "description": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance."1482 },1483 {1484 "parameter": "method.supervised.hyperparameters.learning_rate_multiplier",1485 "type": "string | number",1486 "default": "auto",1487 "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting."1488 },1489 {1490 "parameter": "method.supervised.hyperparameters.n_epochs",1491 "type": "string | integer",1492 "default": "auto",1493 "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset."1494 },1495 {1496 "parameter": "method.dpo",1497 "type": "object",1498 "description": "Configuration for the DPO fine-tuning method."1499 },1500 {1501 "parameter": "method.dpo.hyperparameters",1502 "type": "object",1503 "description": "The hyperparameters used for the DPO fine-tuning job."1504 },1505 {1506 "parameter": "method.dpo.hyperparameters.beta",1507 "type": "string | number",1508 "default": "auto",1509 "description": "The beta value for the DPO method. A higher beta value will increase the weight of the penalty between the policy and reference model."1510 },1511 {1512 "parameter": "method.dpo.hyperparameters.batch_size",1513 "type": "string | integer",1514 "default": "auto",1515 "description": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance."1516 },1517 {1518 "parameter": "method.dpo.hyperparameters.learning_rate_multiplier",1519 "type": "string | number",1520 "default": "auto",1521 "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting."1522 },1523 {1524 "parameter": "method.dpo.hyperparameters.n_epochs",1525 "type": "string | integer",1526 "default": "auto",1527 "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset."1528 },1529 {1530 "parameter": "method.reinforcement",1531 "type": "object",1532 "description": "Configuration for the reinforcement fine-tuning method."1533 },1534 {1535 "parameter": "method.reinforcement.grader",1536 "type": "object",1537 "required": true,1538 "description": "The grader used for the fine-tuning job."1539 },1540 {1541 "parameter": "method.reinforcement.grader.type",1542 "type": "string",1543 "required": true,1544 "enum": [1545 "string_check"1546 ],1547 "description": "The object type, which is always `string_check`."1548 },1549 {1550 "parameter": "method.reinforcement.grader.name",1551 "type": "string",1552 "required": true,1553 "description": "The name of the grader."1554 },1555 {1556 "parameter": "method.reinforcement.grader.input",1557 "type": "string",1558 "required": true,1559 "description": "The input text. This may include template strings."1560 },1561 {1562 "parameter": "method.reinforcement.grader.reference",1563 "type": "string",1564 "required": true,1565 "description": "The reference text. This may include template strings."1566 },1567 {1568 "parameter": "method.reinforcement.grader.operation",1569 "type": "string",1570 "required": true,1571 "enum": [1572 "eq",1573 "ne",1574 "like",1575 "ilike"1576 ],1577 "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`."1578 },1579 {1580 "parameter": "method.reinforcement.grader.type",1581 "type": "string",1582 "required": true,1583 "enum": [1584 "text_similarity"1585 ],1586 "default": "text_similarity",1587 "description": "The type of grader."1588 },1589 {1590 "parameter": "method.reinforcement.grader.name",1591 "type": "string",1592 "required": true,1593 "description": "The name of the grader."1594 },1595 {1596 "parameter": "method.reinforcement.grader.input",1597 "type": "string",1598 "required": true,1599 "description": "The text being graded."1600 },1601 {1602 "parameter": "method.reinforcement.grader.reference",1603 "type": "string",1604 "required": true,1605 "description": "The text being graded against."1606 },1607 {1608 "parameter": "method.reinforcement.grader.evaluation_metric",1609 "type": "string",1610 "required": true,1611 "enum": [1612 "cosine",1613 "fuzzy_match",1614 "bleu",1615 "gleu",1616 "meteor",1617 "rouge_1",1618 "rouge_2",1619 "rouge_3",1620 "rouge_4",1621 "rouge_5",1622 "rouge_l"1623 ],1624 "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`."1625 },1626 {1627 "parameter": "method.reinforcement.grader.type",1628 "type": "string",1629 "required": true,1630 "enum": [1631 "python"1632 ],1633 "description": "The object type, which is always `python`."1634 },1635 {1636 "parameter": "method.reinforcement.grader.name",1637 "type": "string",1638 "required": true,1639 "description": "The name of the grader."1640 },1641 {1642 "parameter": "method.reinforcement.grader.source",1643 "type": "string",1644 "required": true,1645 "description": "The source code of the python script."1646 },1647 {1648 "parameter": "method.reinforcement.grader.image_tag",1649 "type": "string",1650 "description": "The image tag to use for the python script."1651 },1652 {1653 "parameter": "method.reinforcement.grader.type",1654 "type": "string",1655 "required": true,1656 "enum": [1657 "score_model"1658 ],1659 "description": "The object type, which is always `score_model`."1660 },1661 {1662 "parameter": "method.reinforcement.grader.name",1663 "type": "string",1664 "required": true,1665 "description": "The name of the grader."1666 },1667 {1668 "parameter": "method.reinforcement.grader.model",1669 "type": "string",1670 "required": true,1671 "description": "The model to use for the evaluation."1672 },1673 {1674 "parameter": "method.reinforcement.grader.sampling_params",1675 "type": "object",1676 "description": "The sampling parameters for the model."1677 },1678 {1679 "parameter": "method.reinforcement.grader.input",1680 "type": "array<EvalItem>",1681 "required": true,1682 "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings."1683 },1684 {1685 "parameter": "method.reinforcement.grader.range",1686 "type": "array<number>",1687 "description": "The range of the score. Defaults to `[0, 1]`."1688 },1689 {1690 "parameter": "method.reinforcement.grader.type",1691 "type": "string",1692 "required": true,1693 "enum": [1694 "multi"1695 ],1696 "default": "multi",1697 "description": "The object type, which is always `multi`."1698 },1699 {1700 "parameter": "method.reinforcement.grader.name",1701 "type": "string",1702 "required": true,1703 "description": "The name of the grader."1704 },1705 {1706 "parameter": "method.reinforcement.grader.graders",1707 "type": "GraderStringCheck | GraderTextSimilarity | GraderPython | GraderScoreModel | GraderLabelModel",1708 "required": true,1709 "description": ""1710 },1711 {1712 "parameter": "method.reinforcement.grader.calculate_output",1713 "type": "string",1714 "required": true,1715 "description": "A formula to calculate the output based on grader results."1716 },1717 {1718 "parameter": "method.reinforcement.hyperparameters",1719 "type": "object",1720 "description": "The hyperparameters used for the reinforcement fine-tuning job."1721 },1722 {1723 "parameter": "method.reinforcement.hyperparameters.batch_size",1724 "type": "string | integer",1725 "default": "auto",1726 "description": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance."1727 },1728 {1729 "parameter": "method.reinforcement.hyperparameters.learning_rate_multiplier",1730 "type": "string | number",1731 "default": "auto",1732 "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting."1733 },1734 {1735 "parameter": "method.reinforcement.hyperparameters.n_epochs",1736 "type": "string | integer",1737 "default": "auto",1738 "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset."1739 },1740 {1741 "parameter": "method.reinforcement.hyperparameters.reasoning_effort",1742 "type": "string",1743 "enum": [1744 "default",1745 "low",1746 "medium",1747 "high"1748 ],1749 "default": "default",1750 "description": "Level of reasoning effort."1751 },1752 {1753 "parameter": "method.reinforcement.hyperparameters.compute_multiplier",1754 "type": "string | number",1755 "default": "auto",1756 "description": "Multiplier on amount of compute used for exploring search space during training."1757 },1758 {1759 "parameter": "method.reinforcement.hyperparameters.eval_interval",1760 "type": "string | integer",1761 "default": "auto",1762 "description": "The number of training steps between evaluation runs."1763 },1764 {1765 "parameter": "method.reinforcement.hyperparameters.eval_samples",1766 "type": "string | integer",1767 "default": "auto",1768 "description": "Number of evaluation samples to generate per training step."1769 },1770 {1771 "parameter": "metadata",1772 "type": "object | null",1773 "description": ""1774 }1775 ],1776 "status": [1777 "DOCUMENTED",1778 "DEPRECATED"1779 ],1780 "verification": {1781 "method": "docs_only"1782 },1783 "sources": [1784 {1785 "url": "https://developers.openai.com/api/reference/resources/fine_tuning",1786 "retrieved_at": "2026-09-18"1787 },1788 {1789 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",1790 "retrieved_at": "2026-09-18"1791 }1792 ]1793 },1794 {1795 "provider": "openai",1796 "api_family": "fine_tuning",1797 "name": "FineTuningJobEvent",1798 "spec_schema": "FineTuningJobEvent",1799 "object_type": "fine_tuning.job.event",1800 "description": "Fine-tuning job event object",1801 "required": [1802 "id",1803 "object",1804 "created_at",1805 "level",1806 "message"1807 ],1808 "fields": [1809 {1810 "parameter": "object",1811 "type": "string",1812 "required": true,1813 "enum": [1814 "fine_tuning.job.event"1815 ],1816 "description": "The object type, which is always \"fine_tuning.job.event\"."1817 },1818 {1819 "parameter": "id",1820 "type": "string",1821 "required": true,1822 "description": "The object identifier."1823 },1824 {1825 "parameter": "created_at",1826 "type": "integer",1827 "required": true,1828 "description": "The Unix timestamp (in seconds) for when the fine-tuning job was created."1829 },1830 {1831 "parameter": "level",1832 "type": "string",1833 "required": true,1834 "enum": [1835 "info",1836 "warn",1837 "error"1838 ],1839 "description": "The log level of the event."1840 },1841 {1842 "parameter": "message",1843 "type": "string",1844 "required": true,1845 "description": "The message of the event."1846 },1847 {1848 "parameter": "type",1849 "type": "string",1850 "enum": [1851 "message",1852 "metrics"1853 ],1854 "description": "The type of event."1855 },1856 {1857 "parameter": "data",1858 "type": "object",1859 "description": "The data associated with the event."1860 }1861 ],1862 "status": [1863 "DOCUMENTED",1864 "DEPRECATED"1865 ],1866 "verification": {1867 "method": "docs_only"1868 },1869 "sources": [1870 {1871 "url": "https://developers.openai.com/api/reference/resources/fine_tuning",1872 "retrieved_at": "2026-09-18"1873 },1874 {1875 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",1876 "retrieved_at": "2026-09-18"1877 }1878 ]1879 },1880 {1881 "provider": "openai",1882 "api_family": "fine_tuning",1883 "name": "FineTuningJobCheckpoint",1884 "spec_schema": "FineTuningJobCheckpoint",1885 "object_type": "fine_tuning.job.checkpoint",1886 "description": "The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine-tuning job that is ready to use.",1887 "required": [1888 "created_at",1889 "fine_tuning_job_id",1890 "fine_tuned_model_checkpoint",1891 "id",1892 "metrics",1893 "object",1894 "step_number"1895 ],1896 "fields": [1897 {1898 "parameter": "id",1899 "type": "string",1900 "required": true,1901 "description": "The checkpoint identifier, which can be referenced in the API endpoints."1902 },1903 {1904 "parameter": "created_at",1905 "type": "integer",1906 "required": true,1907 "description": "The Unix timestamp (in seconds) for when the checkpoint was created."1908 },1909 {1910 "parameter": "fine_tuned_model_checkpoint",1911 "type": "string",1912 "required": true,1913 "description": "The name of the fine-tuned checkpoint model that is created."1914 },1915 {1916 "parameter": "step_number",1917 "type": "integer",1918 "required": true,1919 "description": "The step number that the checkpoint was created at."1920 },1921 {1922 "parameter": "metrics",1923 "type": "object",1924 "required": true,1925 "description": "Metrics at the step number during the fine-tuning job."1926 },1927 {1928 "parameter": "metrics.step",1929 "type": "number",1930 "description": ""1931 },1932 {1933 "parameter": "metrics.train_loss",1934 "type": "number",1935 "description": ""1936 },1937 {1938 "parameter": "metrics.train_mean_token_accuracy",1939 "type": "number",1940 "description": ""1941 },1942 {1943 "parameter": "metrics.valid_loss",1944 "type": "number",1945 "description": ""1946 },1947 {1948 "parameter": "metrics.valid_mean_token_accuracy",1949 "type": "number",1950 "description": ""1951 },1952 {1953 "parameter": "metrics.full_valid_loss",1954 "type": "number",1955 "description": ""1956 },1957 {1958 "parameter": "metrics.full_valid_mean_token_accuracy",1959 "type": "number",1960 "description": ""1961 },1962 {1963 "parameter": "fine_tuning_job_id",1964 "type": "string",1965 "required": true,1966 "description": "The name of the fine-tuning job that this checkpoint was created from."1967 },1968 {1969 "parameter": "object",1970 "type": "string",1971 "required": true,1972 "enum": [1973 "fine_tuning.job.checkpoint"1974 ],1975 "description": "The object type, which is always \"fine_tuning.job.checkpoint\"."1976 }1977 ],1978 "status": [1979 "DOCUMENTED",1980 "DEPRECATED"1981 ],1982 "verification": {1983 "method": "docs_only"1984 },1985 "sources": [1986 {1987 "url": "https://developers.openai.com/api/reference/resources/fine_tuning",1988 "retrieved_at": "2026-09-18"1989 },1990 {1991 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",1992 "retrieved_at": "2026-09-18"1993 }1994 ]1995 },1996 {1997 "provider": "openai",1998 "api_family": "fine_tuning",1999 "name": "CheckpointPermission",2000 "spec_schema": "FineTuningCheckpointPermission",2001 "object_type": "checkpoint.permission",2002 "description": "The `checkpoint.permission` object represents a permission for a fine-tuned model checkpoint.",2003 "required": [2004 "created_at",2005 "id",2006 "object",2007 "project_id"2008 ],2009 "fields": [2010 {2011 "parameter": "id",2012 "type": "string",2013 "required": true,2014 "description": "The permission identifier, which can be referenced in the API endpoints."2015 },2016 {2017 "parameter": "created_at",2018 "type": "integer",2019 "required": true,2020 "description": "The Unix timestamp (in seconds) for when the permission was created."2021 },2022 {2023 "parameter": "project_id",2024 "type": "string",2025 "required": true,2026 "description": "The project identifier that the permission is for."2027 },2028 {2029 "parameter": "object",2030 "type": "string",2031 "required": true,2032 "enum": [2033 "checkpoint.permission"2034 ],2035 "description": "The object type, which is always \"checkpoint.permission\"."2036 }2037 ],2038 "status": [2039 "DOCUMENTED",2040 "DEPRECATED"2041 ],2042 "verification": {2043 "method": "docs_only"2044 },2045 "sources": [2046 {2047 "url": "https://developers.openai.com/api/reference/resources/fine_tuning",2048 "retrieved_at": "2026-09-18"2049 },2050 {2051 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",2052 "retrieved_at": "2026-09-18"2053 }2054 ]2055 },2056 {2057 "provider": "openai",2058 "api_family": "graders",2059 "name": "GraderStringCheck",2060 "spec_schema": "GraderStringCheck",2061 "object_type": null,2062 "description": "A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.",2063 "required": [2064 "type",2065 "name",2066 "input",2067 "reference",2068 "operation"2069 ],2070 "fields": [2071 {2072 "parameter": "type",2073 "type": "string",2074 "required": true,2075 "enum": [2076 "string_check"2077 ],2078 "description": "The object type, which is always `string_check`."2079 },2080 {2081 "parameter": "name",2082 "type": "string",2083 "required": true,2084 "description": "The name of the grader."2085 },2086 {2087 "parameter": "input",2088 "type": "string",2089 "required": true,2090 "description": "The input text. This may include template strings."2091 },2092 {2093 "parameter": "reference",2094 "type": "string",2095 "required": true,2096 "description": "The reference text. This may include template strings."2097 },2098 {2099 "parameter": "operation",2100 "type": "string",2101 "required": true,2102 "enum": [2103 "eq",2104 "ne",2105 "like",2106 "ilike"2107 ],2108 "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`."2109 }2110 ],2111 "status": [2112 "DOCUMENTED",2113 "DEPRECATED"2114 ],2115 "verification": {2116 "method": "docs_only"2117 },2118 "sources": [2119 {2120 "url": "https://developers.openai.com/api/reference/resources/graders",2121 "retrieved_at": "2026-09-18"2122 },2123 {2124 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",2125 "retrieved_at": "2026-09-18"2126 }2127 ]2128 },2129 {2130 "provider": "openai",2131 "api_family": "graders",2132 "name": "GraderTextSimilarity",2133 "spec_schema": "GraderTextSimilarity",2134 "object_type": null,2135 "description": "A TextSimilarityGrader object which grades text based on similarity metrics.",2136 "required": [2137 "type",2138 "name",2139 "input",2140 "reference",2141 "evaluation_metric"2142 ],2143 "fields": [2144 {2145 "parameter": "type",2146 "type": "string",2147 "required": true,2148 "enum": [2149 "text_similarity"2150 ],2151 "default": "text_similarity",2152 "description": "The type of grader."2153 },2154 {2155 "parameter": "name",2156 "type": "string",2157 "required": true,2158 "description": "The name of the grader."2159 },2160 {2161 "parameter": "input",2162 "type": "string",2163 "required": true,2164 "description": "The text being graded."2165 },2166 {2167 "parameter": "reference",2168 "type": "string",2169 "required": true,2170 "description": "The text being graded against."2171 },2172 {2173 "parameter": "evaluation_metric",2174 "type": "string",2175 "required": true,2176 "enum": [2177 "cosine",2178 "fuzzy_match",2179 "bleu",2180 "gleu",2181 "meteor",2182 "rouge_1",2183 "rouge_2",2184 "rouge_3",2185 "rouge_4",2186 "rouge_5",2187 "rouge_l"2188 ],2189 "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`."2190 }2191 ],2192 "status": [2193 "DOCUMENTED",2194 "DEPRECATED"2195 ],2196 "verification": {2197 "method": "docs_only"2198 },2199 "sources": [2200 {2201 "url": "https://developers.openai.com/api/reference/resources/graders",2202 "retrieved_at": "2026-09-18"2203 },2204 {2205 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",2206 "retrieved_at": "2026-09-18"2207 }2208 ]2209 },2210 {2211 "provider": "openai",2212 "api_family": "graders",2213 "name": "GraderScoreModel",2214 "spec_schema": "GraderScoreModel",2215 "object_type": null,2216 "description": "A ScoreModelGrader object that uses a model to assign a score to the input.",2217 "required": [2218 "type",2219 "name",2220 "input",2221 "model"2222 ],2223 "fields": [2224 {2225 "parameter": "type",2226 "type": "string",2227 "required": true,2228 "enum": [2229 "score_model"2230 ],2231 "description": "The object type, which is always `score_model`."2232 },2233 {2234 "parameter": "name",2235 "type": "string",2236 "required": true,2237 "description": "The name of the grader."2238 },2239 {2240 "parameter": "model",2241 "type": "string",2242 "required": true,2243 "description": "The model to use for the evaluation."2244 },2245 {2246 "parameter": "sampling_params",2247 "type": "object",2248 "description": "The sampling parameters for the model."2249 },2250 {2251 "parameter": "sampling_params.seed",2252 "type": "integer | null",2253 "description": ""2254 },2255 {2256 "parameter": "sampling_params.top_p",2257 "type": "number | null",2258 "description": ""2259 },2260 {2261 "parameter": "sampling_params.temperature",2262 "type": "number | null",2263 "description": ""2264 },2265 {2266 "parameter": "sampling_params.max_completions_tokens",2267 "type": "integer | null",2268 "description": ""2269 },2270 {2271 "parameter": "sampling_params.reasoning_effort",2272 "type": "string | null",2273 "description": ""2274 },2275 {2276 "parameter": "input",2277 "type": "array<object>",2278 "required": true,2279 "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings."2280 },2281 {2282 "parameter": "input[].role",2283 "type": "string",2284 "required": true,2285 "enum": [2286 "user",2287 "assistant",2288 "system",2289 "developer"2290 ],2291 "description": "The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`."2292 },2293 {2294 "parameter": "input[].content",2295 "type": "EvalItemContentItem | array",2296 "required": true,2297 "description": "Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items."2298 },2299 {2300 "parameter": "input[].content.type",2301 "type": "string",2302 "required": true,2303 "enum": [2304 "input_text"2305 ],2306 "default": "input_text",2307 "description": "The type of the input item. Always `input_text`."2308 },2309 {2310 "parameter": "input[].content.text",2311 "type": "string",2312 "required": true,2313 "description": "The text input to the model."2314 },2315 {2316 "parameter": "input[].content.prompt_cache_breakpoint",2317 "type": "object",2318 "description": ""2319 },2320 {2321 "parameter": "input[].content.type",2322 "type": "string",2323 "required": true,2324 "enum": [2325 "output_text"2326 ],2327 "description": "The type of the output text. Always `output_text`."2328 },2329 {2330 "parameter": "input[].content.text",2331 "type": "string",2332 "required": true,2333 "description": "The text output from the model."2334 },2335 {2336 "parameter": "input[].content.type",2337 "type": "string",2338 "required": true,2339 "enum": [2340 "input_image"2341 ],2342 "description": "The type of the image input. Always `input_image`."2343 },2344 {2345 "parameter": "input[].content.image_url",2346 "type": "string",2347 "required": true,2348 "description": "The URL of the image input."2349 },2350 {2351 "parameter": "input[].content.detail",2352 "type": "string",2353 "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."2354 },2355 {2356 "parameter": "input[].content.type",2357 "type": "string",2358 "required": true,2359 "enum": [2360 "input_audio"2361 ],2362 "description": "The type of the input item. Always `input_audio`."2363 },2364 {2365 "parameter": "input[].content.input_audio",2366 "type": "object",2367 "required": true,2368 "description": ""2369 },2370 {2371 "parameter": "input[].content.input_audio.data",2372 "type": "string",2373 "required": true,2374 "description": "Base64-encoded audio data."2375 },2376 {2377 "parameter": "input[].content.input_audio.format",2378 "type": "string",2379 "required": true,2380 "enum": [2381 "mp3",2382 "wav"2383 ],2384 "description": "The format of the audio data. Currently supported formats are `mp3` and\n`wav`."2385 },2386 {2387 "parameter": "input[].type",2388 "type": "string",2389 "enum": [2390 "message"2391 ],2392 "description": "The type of the message input. Always `message`."2393 },2394 {2395 "parameter": "range",2396 "type": "array<number>",2397 "description": "The range of the score. Defaults to `[0, 1]`."2398 }2399 ],2400 "status": [2401 "DOCUMENTED",2402 "DEPRECATED"2403 ],2404 "verification": {2405 "method": "docs_only"2406 },2407 "sources": [2408 {2409 "url": "https://developers.openai.com/api/reference/resources/graders",2410 "retrieved_at": "2026-09-18"2411 },2412 {2413 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",2414 "retrieved_at": "2026-09-18"2415 }2416 ]2417 },2418 {2419 "provider": "openai",2420 "api_family": "graders",2421 "name": "GraderLabelModel",2422 "spec_schema": "GraderLabelModel",2423 "object_type": null,2424 "description": "A LabelModelGrader object which uses a model to assign labels to each item\nin the evaluation.",2425 "required": [2426 "type",2427 "model",2428 "input",2429 "passing_labels",2430 "labels",2431 "name"2432 ],2433 "fields": [2434 {2435 "parameter": "type",2436 "type": "string",2437 "required": true,2438 "enum": [2439 "label_model"2440 ],2441 "description": "The object type, which is always `label_model`."2442 },2443 {2444 "parameter": "name",2445 "type": "string",2446 "required": true,2447 "description": "The name of the grader."2448 },2449 {2450 "parameter": "model",2451 "type": "string",2452 "required": true,2453 "description": "The model to use for the evaluation. Must support structured outputs."2454 },2455 {2456 "parameter": "input",2457 "type": "array<object>",2458 "required": true,2459 "description": ""2460 },2461 {2462 "parameter": "input[].role",2463 "type": "string",2464 "required": true,2465 "enum": [2466 "user",2467 "assistant",2468 "system",2469 "developer"2470 ],2471 "description": "The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`."2472 },2473 {2474 "parameter": "input[].content",2475 "type": "EvalItemContentItem | array",2476 "required": true,2477 "description": "Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items."2478 },2479 {2480 "parameter": "input[].content.type",2481 "type": "string",2482 "required": true,2483 "enum": [2484 "input_text"2485 ],2486 "default": "input_text",2487 "description": "The type of the input item. Always `input_text`."2488 },2489 {2490 "parameter": "input[].content.text",2491 "type": "string",2492 "required": true,2493 "description": "The text input to the model."2494 },2495 {2496 "parameter": "input[].content.prompt_cache_breakpoint",2497 "type": "object",2498 "description": ""2499 },2500 {2501 "parameter": "input[].content.type",2502 "type": "string",2503 "required": true,2504 "enum": [2505 "output_text"2506 ],2507 "description": "The type of the output text. Always `output_text`."2508 },2509 {2510 "parameter": "input[].content.text",2511 "type": "string",2512 "required": true,2513 "description": "The text output from the model."2514 },2515 {2516 "parameter": "input[].content.type",2517 "type": "string",2518 "required": true,2519 "enum": [2520 "input_image"2521 ],2522 "description": "The type of the image input. Always `input_image`."2523 },2524 {2525 "parameter": "input[].content.image_url",2526 "type": "string",2527 "required": true,2528 "description": "The URL of the image input."2529 },2530 {2531 "parameter": "input[].content.detail",2532 "type": "string",2533 "description": "The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."2534 },2535 {2536 "parameter": "input[].content.type",2537 "type": "string",2538 "required": true,2539 "enum": [2540 "input_audio"2541 ],2542 "description": "The type of the input item. Always `input_audio`."2543 },2544 {2545 "parameter": "input[].content.input_audio",2546 "type": "object",2547 "required": true,2548 "description": ""2549 },2550 {2551 "parameter": "input[].content.input_audio.data",2552 "type": "string",2553 "required": true,2554 "description": "Base64-encoded audio data."2555 },2556 {2557 "parameter": "input[].content.input_audio.format",2558 "type": "string",2559 "required": true,2560 "enum": [2561 "mp3",2562 "wav"2563 ],2564 "description": "The format of the audio data. Currently supported formats are `mp3` and\n`wav`."2565 },2566 {2567 "parameter": "input[].type",2568 "type": "string",2569 "enum": [2570 "message"2571 ],2572 "description": "The type of the message input. Always `message`."2573 },2574 {2575 "parameter": "labels",2576 "type": "array<string>",2577 "required": true,2578 "description": "The labels to assign to each item in the evaluation."2579 },2580 {2581 "parameter": "passing_labels",2582 "type": "array<string>",2583 "required": true,2584 "description": "The labels that indicate a passing result. Must be a subset of labels."2585 }2586 ],2587 "status": [2588 "DOCUMENTED",2589 "DEPRECATED"2590 ],2591 "verification": {2592 "method": "docs_only"2593 },2594 "sources": [2595 {2596 "url": "https://developers.openai.com/api/reference/resources/graders",2597 "retrieved_at": "2026-09-18"2598 },2599 {2600 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",2601 "retrieved_at": "2026-09-18"2602 }2603 ]2604 },2605 {2606 "provider": "openai",2607 "api_family": "graders",2608 "name": "GraderPython",2609 "spec_schema": "GraderPython",2610 "object_type": null,2611 "description": "A PythonGrader object that runs a python script on the input.",2612 "required": [2613 "type",2614 "name",2615 "source"2616 ],2617 "fields": [2618 {2619 "parameter": "type",2620 "type": "string",2621 "required": true,2622 "enum": [2623 "python"2624 ],2625 "description": "The object type, which is always `python`."2626 },2627 {2628 "parameter": "name",2629 "type": "string",2630 "required": true,2631 "description": "The name of the grader."2632 },2633 {2634 "parameter": "source",2635 "type": "string",2636 "required": true,2637 "description": "The source code of the python script."2638 },2639 {2640 "parameter": "image_tag",2641 "type": "string",2642 "description": "The image tag to use for the python script."2643 }2644 ],2645 "status": [2646 "DOCUMENTED",2647 "DEPRECATED"2648 ],2649 "verification": {2650 "method": "docs_only"2651 },2652 "sources": [2653 {2654 "url": "https://developers.openai.com/api/reference/resources/graders",2655 "retrieved_at": "2026-09-18"2656 },2657 {2658 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",2659 "retrieved_at": "2026-09-18"2660 }2661 ]2662 },2663 {2664 "provider": "openai",2665 "api_family": "graders",2666 "name": "GraderMulti",2667 "spec_schema": "GraderMulti",2668 "object_type": null,2669 "description": "A MultiGrader object combines the output of multiple graders to produce a single score.",2670 "required": [2671 "name",2672 "type",2673 "graders",2674 "calculate_output"2675 ],2676 "fields": [2677 {2678 "parameter": "type",2679 "type": "string",2680 "required": true,2681 "enum": [2682 "multi"2683 ],2684 "default": "multi",2685 "description": "The object type, which is always `multi`."2686 },2687 {2688 "parameter": "name",2689 "type": "string",2690 "required": true,2691 "description": "The name of the grader."2692 },2693 {2694 "parameter": "graders",2695 "type": "object | object | object | object | object",2696 "required": true,2697 "description": ""2698 },2699 {2700 "parameter": "graders.type",2701 "type": "string",2702 "required": true,2703 "enum": [2704 "string_check"2705 ],2706 "description": "The object type, which is always `string_check`."2707 },2708 {2709 "parameter": "graders.name",2710 "type": "string",2711 "required": true,2712 "description": "The name of the grader."2713 },2714 {2715 "parameter": "graders.input",2716 "type": "string",2717 "required": true,2718 "description": "The input text. This may include template strings."2719 },2720 {2721 "parameter": "graders.reference",2722 "type": "string",2723 "required": true,2724 "description": "The reference text. This may include template strings."2725 },2726 {2727 "parameter": "graders.operation",2728 "type": "string",2729 "required": true,2730 "enum": [2731 "eq",2732 "ne",2733 "like",2734 "ilike"2735 ],2736 "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`."2737 },2738 {2739 "parameter": "graders.type",2740 "type": "string",2741 "required": true,2742 "enum": [2743 "text_similarity"2744 ],2745 "default": "text_similarity",2746 "description": "The type of grader."2747 },2748 {2749 "parameter": "graders.name",2750 "type": "string",2751 "required": true,2752 "description": "The name of the grader."2753 },2754 {2755 "parameter": "graders.input",2756 "type": "string",2757 "required": true,2758 "description": "The text being graded."2759 },2760 {2761 "parameter": "graders.reference",2762 "type": "string",2763 "required": true,2764 "description": "The text being graded against."2765 },2766 {2767 "parameter": "graders.evaluation_metric",2768 "type": "string",2769 "required": true,2770 "enum": [2771 "cosine",2772 "fuzzy_match",2773 "bleu",2774 "gleu",2775 "meteor",2776 "rouge_1",2777 "rouge_2",2778 "rouge_3",2779 "rouge_4",2780 "rouge_5",2781 "rouge_l"2782 ],2783 "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`."2784 },2785 {2786 "parameter": "graders.type",2787 "type": "string",2788 "required": true,2789 "enum": [2790 "python"2791 ],2792 "description": "The object type, which is always `python`."2793 },2794 {2795 "parameter": "graders.name",2796 "type": "string",2797 "required": true,2798 "description": "The name of the grader."2799 },2800 {2801 "parameter": "graders.source",2802 "type": "string",2803 "required": true,2804 "description": "The source code of the python script."2805 },2806 {2807 "parameter": "graders.image_tag",2808 "type": "string",2809 "description": "The image tag to use for the python script."2810 },2811 {2812 "parameter": "graders.type",2813 "type": "string",2814 "required": true,2815 "enum": [2816 "score_model"2817 ],2818 "description": "The object type, which is always `score_model`."2819 },2820 {2821 "parameter": "graders.name",2822 "type": "string",2823 "required": true,2824 "description": "The name of the grader."2825 },2826 {2827 "parameter": "graders.model",2828 "type": "string",2829 "required": true,2830 "description": "The model to use for the evaluation."2831 },2832 {2833 "parameter": "graders.sampling_params",2834 "type": "object",2835 "description": "The sampling parameters for the model."2836 },2837 {2838 "parameter": "graders.sampling_params.seed",2839 "type": "integer | null",2840 "description": ""2841 },2842 {2843 "parameter": "graders.sampling_params.top_p",2844 "type": "number | null",2845 "description": ""2846 },2847 {2848 "parameter": "graders.sampling_params.temperature",2849 "type": "number | null",2850 "description": ""2851 },2852 {2853 "parameter": "graders.sampling_params.max_completions_tokens",2854 "type": "integer | null",2855 "description": ""2856 },2857 {2858 "parameter": "graders.sampling_params.reasoning_effort",2859 "type": "string | null",2860 "description": ""2861 },2862 {2863 "parameter": "graders.input",2864 "type": "array<object>",2865 "required": true,2866 "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings."2867 },2868 {2869 "parameter": "graders.input[].role",2870 "type": "string",2871 "required": true,2872 "enum": [2873 "user",2874 "assistant",2875 "system",2876 "developer"2877 ],2878 "description": "The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`."2879 },2880 {2881 "parameter": "graders.input[].content",2882 "type": "EvalItemContentItem | EvalItemContentArray",2883 "required": true,2884 "description": "Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items."2885 },2886 {2887 "parameter": "graders.input[].type",2888 "type": "string",2889 "enum": [2890 "message"2891 ],2892 "description": "The type of the message input. Always `message`."2893 },2894 {2895 "parameter": "graders.range",2896 "type": "array<number>",2897 "description": "The range of the score. Defaults to `[0, 1]`."2898 },2899 {2900 "parameter": "graders.type",2901 "type": "string",2902 "required": true,2903 "enum": [2904 "label_model"2905 ],2906 "description": "The object type, which is always `label_model`."2907 },2908 {2909 "parameter": "graders.name",2910 "type": "string",2911 "required": true,2912 "description": "The name of the grader."2913 },2914 {2915 "parameter": "graders.model",2916 "type": "string",2917 "required": true,2918 "description": "The model to use for the evaluation. Must support structured outputs."2919 },2920 {2921 "parameter": "graders.input",2922 "type": "array<object>",2923 "required": true,2924 "description": ""2925 },2926 {2927 "parameter": "graders.input[].role",2928 "type": "string",2929 "required": true,2930 "enum": [2931 "user",2932 "assistant",2933 "system",2934 "developer"2935 ],2936 "description": "The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`."2937 },2938 {2939 "parameter": "graders.input[].content",2940 "type": "EvalItemContentItem | EvalItemContentArray",2941 "required": true,2942 "description": "Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items."2943 },2944 {2945 "parameter": "graders.input[].type",2946 "type": "string",2947 "enum": [2948 "message"2949 ],2950 "description": "The type of the message input. Always `message`."2951 },2952 {2953 "parameter": "graders.labels",2954 "type": "array<string>",2955 "required": true,2956 "description": "The labels to assign to each item in the evaluation."2957 },2958 {2959 "parameter": "graders.passing_labels",2960 "type": "array<string>",2961 "required": true,2962 "description": "The labels that indicate a passing result. Must be a subset of labels."2963 },2964 {2965 "parameter": "calculate_output",2966 "type": "string",2967 "required": true,2968 "description": "A formula to calculate the output based on grader results."2969 }2970 ],2971 "status": [2972 "DOCUMENTED",2973 "DEPRECATED"2974 ],2975 "verification": {2976 "method": "docs_only"2977 },2978 "sources": [2979 {2980 "url": "https://developers.openai.com/api/reference/resources/graders",2981 "retrieved_at": "2026-09-18"2982 },2983 {2984 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",2985 "retrieved_at": "2026-09-18"2986 }2987 ]2988 },2989 {2990 "provider": "openai",2991 "api_family": "graders",2992 "name": "RunGraderResponse",2993 "spec_schema": "RunGraderResponse",2994 "object_type": null,2995 "description": "",2996 "required": [2997 "reward",2998 "metadata",2999 "sub_rewards",3000 "model_grader_token_usage_per_model"3001 ],3002 "fields": [3003 {3004 "parameter": "reward",3005 "type": "number",3006 "required": true,3007 "description": ""3008 },3009 {3010 "parameter": "metadata",3011 "type": "object",3012 "required": true,3013 "description": ""3014 },3015 {3016 "parameter": "metadata.name",3017 "type": "string",3018 "required": true,3019 "description": ""3020 },3021 {3022 "parameter": "metadata.type",3023 "type": "string",3024 "required": true,3025 "description": ""3026 },3027 {3028 "parameter": "metadata.errors",3029 "type": "object",3030 "required": true,3031 "description": ""3032 },3033 {3034 "parameter": "metadata.errors.formula_parse_error",3035 "type": "boolean",3036 "required": true,3037 "description": ""3038 },3039 {3040 "parameter": "metadata.errors.sample_parse_error",3041 "type": "boolean",3042 "required": true,3043 "description": ""3044 },3045 {3046 "parameter": "metadata.errors.truncated_observation_error",3047 "type": "boolean",3048 "required": true,3049 "description": ""3050 },3051 {3052 "parameter": "metadata.errors.unresponsive_reward_error",3053 "type": "boolean",3054 "required": true,3055 "description": ""3056 },3057 {3058 "parameter": "metadata.errors.invalid_variable_error",3059 "type": "boolean",3060 "required": true,3061 "description": ""3062 },3063 {3064 "parameter": "metadata.errors.other_error",3065 "type": "boolean",3066 "required": true,3067 "description": ""3068 },3069 {3070 "parameter": "metadata.errors.python_grader_server_error",3071 "type": "boolean",3072 "required": true,3073 "description": ""3074 },3075 {3076 "parameter": "metadata.errors.python_grader_server_error_type",3077 "type": "string | null",3078 "required": true,3079 "description": ""3080 },3081 {3082 "parameter": "metadata.errors.python_grader_runtime_error",3083 "type": "boolean",3084 "required": true,3085 "description": ""3086 },3087 {3088 "parameter": "metadata.errors.python_grader_runtime_error_details",3089 "type": "string | null",3090 "required": true,3091 "description": ""3092 },3093 {3094 "parameter": "metadata.errors.model_grader_server_error",3095 "type": "boolean",3096 "required": true,3097 "description": ""3098 },3099 {3100 "parameter": "metadata.errors.model_grader_refusal_error",3101 "type": "boolean",3102 "required": true,3103 "description": ""3104 },3105 {3106 "parameter": "metadata.errors.model_grader_parse_error",3107 "type": "boolean",3108 "required": true,3109 "description": ""3110 },3111 {3112 "parameter": "metadata.errors.model_grader_server_error_details",3113 "type": "string | null",3114 "required": true,3115 "description": ""3116 },3117 {3118 "parameter": "metadata.execution_time",3119 "type": "number",3120 "required": true,3121 "description": ""3122 },3123 {3124 "parameter": "metadata.scores",3125 "type": "object",3126 "required": true,3127 "description": ""3128 },3129 {3130 "parameter": "metadata.token_usage",3131 "type": "integer | null",3132 "required": true,3133 "description": ""3134 },3135 {3136 "parameter": "metadata.sampled_model_name",3137 "type": "string | null",3138 "required": true,3139 "description": ""3140 },3141 {3142 "parameter": "sub_rewards",3143 "type": "object",3144 "required": true,3145 "description": ""3146 },3147 {3148 "parameter": "model_grader_token_usage_per_model",3149 "type": "object",3150 "required": true,3151 "description": ""3152 }3153 ],3154 "status": [3155 "DOCUMENTED",3156 "DEPRECATED"3157 ],3158 "verification": {3159 "method": "docs_only"3160 },3161 "sources": [3162 {3163 "url": "https://developers.openai.com/api/reference/resources/graders",3164 "retrieved_at": "2026-09-18"3165 },3166 {3167 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",3168 "retrieved_at": "2026-09-18"3169 }3170 ]3171 },3172 {3173 "provider": "openai",3174 "api_family": "graders",3175 "name": "ValidateGraderResponse",3176 "spec_schema": "ValidateGraderResponse",3177 "object_type": null,3178 "description": "",3179 "required": [],3180 "fields": [3181 {3182 "parameter": "grader",3183 "type": "object",3184 "description": "The grader used for the fine-tuning job."3185 },3186 {3187 "parameter": "grader.type",3188 "type": "string",3189 "required": true,3190 "enum": [3191 "string_check"3192 ],3193 "description": "The object type, which is always `string_check`."3194 },3195 {3196 "parameter": "grader.name",3197 "type": "string",3198 "required": true,3199 "description": "The name of the grader."3200 },3201 {3202 "parameter": "grader.input",3203 "type": "string",3204 "required": true,3205 "description": "The input text. This may include template strings."3206 },3207 {3208 "parameter": "grader.reference",3209 "type": "string",3210 "required": true,3211 "description": "The reference text. This may include template strings."3212 },3213 {3214 "parameter": "grader.operation",3215 "type": "string",3216 "required": true,3217 "enum": [3218 "eq",3219 "ne",3220 "like",3221 "ilike"3222 ],3223 "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`."3224 },3225 {3226 "parameter": "grader.type",3227 "type": "string",3228 "required": true,3229 "enum": [3230 "text_similarity"3231 ],3232 "default": "text_similarity",3233 "description": "The type of grader."3234 },3235 {3236 "parameter": "grader.name",3237 "type": "string",3238 "required": true,3239 "description": "The name of the grader."3240 },3241 {3242 "parameter": "grader.input",3243 "type": "string",3244 "required": true,3245 "description": "The text being graded."3246 },3247 {3248 "parameter": "grader.reference",3249 "type": "string",3250 "required": true,3251 "description": "The text being graded against."3252 },3253 {3254 "parameter": "grader.evaluation_metric",3255 "type": "string",3256 "required": true,3257 "enum": [3258 "cosine",3259 "fuzzy_match",3260 "bleu",3261 "gleu",3262 "meteor",3263 "rouge_1",3264 "rouge_2",3265 "rouge_3",3266 "rouge_4",3267 "rouge_5",3268 "rouge_l"3269 ],3270 "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`."3271 },3272 {3273 "parameter": "grader.type",3274 "type": "string",3275 "required": true,3276 "enum": [3277 "python"3278 ],3279 "description": "The object type, which is always `python`."3280 },3281 {3282 "parameter": "grader.name",3283 "type": "string",3284 "required": true,3285 "description": "The name of the grader."3286 },3287 {3288 "parameter": "grader.source",3289 "type": "string",3290 "required": true,3291 "description": "The source code of the python script."3292 },3293 {3294 "parameter": "grader.image_tag",3295 "type": "string",3296 "description": "The image tag to use for the python script."3297 },3298 {3299 "parameter": "grader.type",3300 "type": "string",3301 "required": true,3302 "enum": [3303 "score_model"3304 ],3305 "description": "The object type, which is always `score_model`."3306 },3307 {3308 "parameter": "grader.name",3309 "type": "string",3310 "required": true,3311 "description": "The name of the grader."3312 },3313 {3314 "parameter": "grader.model",3315 "type": "string",3316 "required": true,3317 "description": "The model to use for the evaluation."3318 },3319 {3320 "parameter": "grader.sampling_params",3321 "type": "object",3322 "description": "The sampling parameters for the model."3323 },3324 {3325 "parameter": "grader.sampling_params.seed",3326 "type": "integer | null",3327 "description": ""3328 },3329 {3330 "parameter": "grader.sampling_params.top_p",3331 "type": "number | null",3332 "description": ""3333 },3334 {3335 "parameter": "grader.sampling_params.temperature",3336 "type": "number | null",3337 "description": ""3338 },3339 {3340 "parameter": "grader.sampling_params.max_completions_tokens",3341 "type": "integer | null",3342 "description": ""3343 },3344 {3345 "parameter": "grader.sampling_params.reasoning_effort",3346 "type": "string | null",3347 "description": ""3348 },3349 {3350 "parameter": "grader.input",3351 "type": "array<object>",3352 "required": true,3353 "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings."3354 },3355 {3356 "parameter": "grader.input[].role",3357 "type": "string",3358 "required": true,3359 "enum": [3360 "user",3361 "assistant",3362 "system",3363 "developer"3364 ],3365 "description": "The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`."3366 },3367 {3368 "parameter": "grader.input[].content",3369 "type": "EvalItemContentItem | EvalItemContentArray",3370 "required": true,3371 "description": "Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items."3372 },3373 {3374 "parameter": "grader.input[].type",3375 "type": "string",3376 "enum": [3377 "message"3378 ],3379 "description": "The type of the message input. Always `message`."3380 },3381 {3382 "parameter": "grader.range",3383 "type": "array<number>",3384 "description": "The range of the score. Defaults to `[0, 1]`."3385 },3386 {3387 "parameter": "grader.type",3388 "type": "string",3389 "required": true,3390 "enum": [3391 "multi"3392 ],3393 "default": "multi",3394 "description": "The object type, which is always `multi`."3395 },3396 {3397 "parameter": "grader.name",3398 "type": "string",3399 "required": true,3400 "description": "The name of the grader."3401 },3402 {3403 "parameter": "grader.graders",3404 "type": "object | object | object | object | object",3405 "required": true,3406 "description": ""3407 },3408 {3409 "parameter": "grader.graders.type",3410 "type": "string",3411 "required": true,3412 "enum": [3413 "string_check"3414 ],3415 "description": "The object type, which is always `string_check`."3416 },3417 {3418 "parameter": "grader.graders.name",3419 "type": "string",3420 "required": true,3421 "description": "The name of the grader."3422 },3423 {3424 "parameter": "grader.graders.input",3425 "type": "string",3426 "required": true,3427 "description": "The input text. This may include template strings."3428 },3429 {3430 "parameter": "grader.graders.reference",3431 "type": "string",3432 "required": true,3433 "description": "The reference text. This may include template strings."3434 },3435 {3436 "parameter": "grader.graders.operation",3437 "type": "string",3438 "required": true,3439 "enum": [3440 "eq",3441 "ne",3442 "like",3443 "ilike"3444 ],3445 "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`."3446 },3447 {3448 "parameter": "grader.graders.type",3449 "type": "string",3450 "required": true,3451 "enum": [3452 "text_similarity"3453 ],3454 "default": "text_similarity",3455 "description": "The type of grader."3456 },3457 {3458 "parameter": "grader.graders.name",3459 "type": "string",3460 "required": true,3461 "description": "The name of the grader."3462 },3463 {3464 "parameter": "grader.graders.input",3465 "type": "string",3466 "required": true,3467 "description": "The text being graded."3468 },3469 {3470 "parameter": "grader.graders.reference",3471 "type": "string",3472 "required": true,3473 "description": "The text being graded against."3474 },3475 {3476 "parameter": "grader.graders.evaluation_metric",3477 "type": "string",3478 "required": true,3479 "enum": [3480 "cosine",3481 "fuzzy_match",3482 "bleu",3483 "gleu",3484 "meteor",3485 "rouge_1",3486 "rouge_2",3487 "rouge_3",3488 "rouge_4",3489 "rouge_5",3490 "rouge_l"3491 ],3492 "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`."3493 },3494 {3495 "parameter": "grader.graders.type",3496 "type": "string",3497 "required": true,3498 "enum": [3499 "python"3500 ],3501 "description": "The object type, which is always `python`."3502 },3503 {3504 "parameter": "grader.graders.name",3505 "type": "string",3506 "required": true,3507 "description": "The name of the grader."3508 },3509 {3510 "parameter": "grader.graders.source",3511 "type": "string",3512 "required": true,3513 "description": "The source code of the python script."3514 },3515 {3516 "parameter": "grader.graders.image_tag",3517 "type": "string",3518 "description": "The image tag to use for the python script."3519 },3520 {3521 "parameter": "grader.graders.type",3522 "type": "string",3523 "required": true,3524 "enum": [3525 "score_model"3526 ],3527 "description": "The object type, which is always `score_model`."3528 },3529 {3530 "parameter": "grader.graders.name",3531 "type": "string",3532 "required": true,3533 "description": "The name of the grader."3534 },3535 {3536 "parameter": "grader.graders.model",3537 "type": "string",3538 "required": true,3539 "description": "The model to use for the evaluation."3540 },3541 {3542 "parameter": "grader.graders.sampling_params",3543 "type": "object",3544 "description": "The sampling parameters for the model."3545 },3546 {3547 "parameter": "grader.graders.sampling_params.seed",3548 "type": "integer | null",3549 "description": ""3550 },3551 {3552 "parameter": "grader.graders.sampling_params.top_p",3553 "type": "number | null",3554 "description": ""3555 },3556 {3557 "parameter": "grader.graders.sampling_params.temperature",3558 "type": "number | null",3559 "description": ""3560 },3561 {3562 "parameter": "grader.graders.sampling_params.max_completions_tokens",3563 "type": "integer | null",3564 "description": ""3565 },3566 {3567 "parameter": "grader.graders.sampling_params.reasoning_effort",3568 "type": "object",3569 "description": ""3570 },3571 {3572 "parameter": "grader.graders.input",3573 "type": "array<EvalItem>",3574 "required": true,3575 "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings."3576 },3577 {3578 "parameter": "grader.graders.range",3579 "type": "array<number>",3580 "description": "The range of the score. Defaults to `[0, 1]`."3581 },3582 {3583 "parameter": "grader.graders.type",3584 "type": "string",3585 "required": true,3586 "enum": [3587 "label_model"3588 ],3589 "description": "The object type, which is always `label_model`."3590 },3591 {3592 "parameter": "grader.graders.name",3593 "type": "string",3594 "required": true,3595 "description": "The name of the grader."3596 },3597 {3598 "parameter": "grader.graders.model",3599 "type": "string",3600 "required": true,3601 "description": "The model to use for the evaluation. Must support structured outputs."3602 },3603 {3604 "parameter": "grader.graders.input",3605 "type": "array<EvalItem>",3606 "required": true,3607 "description": ""3608 },3609 {3610 "parameter": "grader.graders.labels",3611 "type": "array<string>",3612 "required": true,3613 "description": "The labels to assign to each item in the evaluation."3614 },3615 {3616 "parameter": "grader.graders.passing_labels",3617 "type": "array<string>",3618 "required": true,3619 "description": "The labels that indicate a passing result. Must be a subset of labels."3620 },3621 {3622 "parameter": "grader.calculate_output",3623 "type": "string",3624 "required": true,3625 "description": "A formula to calculate the output based on grader results."3626 }3627 ],3628 "status": [3629 "DOCUMENTED",3630 "DEPRECATED"3631 ],3632 "verification": {3633 "method": "docs_only"3634 },3635 "sources": [3636 {3637 "url": "https://developers.openai.com/api/reference/resources/graders",3638 "retrieved_at": "2026-09-18"3639 },3640 {3641 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",3642 "retrieved_at": "2026-09-18"3643 }3644 ]3645 },3646 {3647 "provider": "openai",3648 "api_family": "evals",3649 "name": "Eval",3650 "spec_schema": "Eval",3651 "object_type": "eval",3652 "description": "An Eval object with a data source config and testing criteria.\nAn Eval represents a task to be done for your LLM integration.\nLike:\n - Improve the quality of my chatbot\n - See how well my chatbot handles customer support\n - Check if o4-mini is better at my usecase than gpt-6-astra",3653 "required": [3654 "id",3655 "data_source_config",3656 "object",3657 "testing_criteria",3658 "name",3659 "created_at",3660 "metadata"3661 ],3662 "fields": [3663 {3664 "parameter": "object",3665 "type": "string",3666 "required": true,3667 "enum": [3668 "eval"3669 ],3670 "default": "eval",3671 "description": "The object type."3672 },3673 {3674 "parameter": "id",3675 "type": "string",3676 "required": true,3677 "description": "Unique identifier for the evaluation."3678 },3679 {3680 "parameter": "name",3681 "type": "string",3682 "required": true,3683 "description": "The name of the evaluation."3684 },3685 {3686 "parameter": "data_source_config",3687 "type": "object",3688 "required": true,3689 "description": "Configuration of data sources used in runs of the evaluation."3690 },3691 {3692 "parameter": "data_source_config.type",3693 "type": "string",3694 "required": true,3695 "enum": [3696 "custom"3697 ],3698 "default": "custom",3699 "description": "The type of data source. Always `custom`."3700 },3701 {3702 "parameter": "data_source_config.schema",3703 "type": "object",3704 "required": true,3705 "description": "The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/)."3706 },3707 {3708 "parameter": "data_source_config.type",3709 "type": "string",3710 "required": true,3711 "enum": [3712 "logs"3713 ],3714 "default": "logs",3715 "description": "The type of data source. Always `logs`."3716 },3717 {3718 "parameter": "data_source_config.metadata",3719 "type": "object | null",3720 "description": ""3721 },3722 {3723 "parameter": "data_source_config.schema",3724 "type": "object",3725 "required": true,3726 "description": "The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/)."3727 },3728 {3729 "parameter": "data_source_config.type",3730 "type": "string",3731 "required": true,3732 "enum": [3733 "stored_completions"3734 ],3735 "default": "stored_completions",3736 "description": "The type of data source. Always `stored_completions`."3737 },3738 {3739 "parameter": "data_source_config.metadata",3740 "type": "object | null",3741 "description": ""3742 },3743 {3744 "parameter": "data_source_config.schema",3745 "type": "object",3746 "required": true,3747 "description": "The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/)."3748 },3749 {3750 "parameter": "testing_criteria",3751 "type": "array<object>",3752 "required": true,3753 "description": "A list of testing criteria."3754 },3755 {3756 "parameter": "testing_criteria[].type",3757 "type": "string",3758 "required": true,3759 "enum": [3760 "label_model"3761 ],3762 "description": "The object type, which is always `label_model`."3763 },3764 {3765 "parameter": "testing_criteria[].name",3766 "type": "string",3767 "required": true,3768 "description": "The name of the grader."3769 },3770 {3771 "parameter": "testing_criteria[].model",3772 "type": "string",3773 "required": true,3774 "description": "The model to use for the evaluation. Must support structured outputs."3775 },3776 {3777 "parameter": "testing_criteria[].input",3778 "type": "array<object>",3779 "required": true,3780 "description": ""3781 },3782 {3783 "parameter": "testing_criteria[].input[].role",3784 "type": "string",3785 "required": true,3786 "enum": [3787 "user",3788 "assistant",3789 "system",3790 "developer"3791 ],3792 "description": "The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`."3793 },3794 {3795 "parameter": "testing_criteria[].input[].content",3796 "required": true,3797 "type": "object",3798 "description": ""3799 },3800 {3801 "parameter": "testing_criteria[].input[].type",3802 "type": "string",3803 "enum": [3804 "message"3805 ],3806 "description": "The type of the message input. Always `message`."3807 },3808 {3809 "parameter": "testing_criteria[].labels",3810 "type": "array<string>",3811 "required": true,3812 "description": "The labels to assign to each item in the evaluation."3813 },3814 {3815 "parameter": "testing_criteria[].passing_labels",3816 "type": "array<string>",3817 "required": true,3818 "description": "The labels that indicate a passing result. Must be a subset of labels."3819 },3820 {3821 "parameter": "testing_criteria[].type",3822 "type": "string",3823 "required": true,3824 "enum": [3825 "string_check"3826 ],3827 "description": "The object type, which is always `string_check`."3828 },3829 {3830 "parameter": "testing_criteria[].name",3831 "type": "string",3832 "required": true,3833 "description": "The name of the grader."3834 },3835 {3836 "parameter": "testing_criteria[].input",3837 "type": "string",3838 "required": true,3839 "description": "The input text. This may include template strings."3840 },3841 {3842 "parameter": "testing_criteria[].reference",3843 "type": "string",3844 "required": true,3845 "description": "The reference text. This may include template strings."3846 },3847 {3848 "parameter": "testing_criteria[].operation",3849 "type": "string",3850 "required": true,3851 "enum": [3852 "eq",3853 "ne",3854 "like",3855 "ilike"3856 ],3857 "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`."3858 },3859 {3860 "parameter": "testing_criteria[].type",3861 "type": "string",3862 "required": true,3863 "enum": [3864 "text_similarity"3865 ],3866 "default": "text_similarity",3867 "description": "The type of grader."3868 },3869 {3870 "parameter": "testing_criteria[].name",3871 "type": "string",3872 "required": true,3873 "description": "The name of the grader."3874 },3875 {3876 "parameter": "testing_criteria[].input",3877 "type": "string",3878 "required": true,3879 "description": "The text being graded."3880 },3881 {3882 "parameter": "testing_criteria[].reference",3883 "type": "string",3884 "required": true,3885 "description": "The text being graded against."3886 },3887 {3888 "parameter": "testing_criteria[].evaluation_metric",3889 "type": "string",3890 "required": true,3891 "enum": [3892 "cosine",3893 "fuzzy_match",3894 "bleu",3895 "gleu",3896 "meteor",3897 "rouge_1",3898 "rouge_2",3899 "rouge_3",3900 "rouge_4",3901 "rouge_5",3902 "rouge_l"3903 ],3904 "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`."3905 },3906 {3907 "parameter": "testing_criteria[].pass_threshold",3908 "type": "number",3909 "required": true,3910 "description": "The threshold for the score."3911 },3912 {3913 "parameter": "testing_criteria[].type",3914 "type": "string",3915 "required": true,3916 "enum": [3917 "python"3918 ],3919 "description": "The object type, which is always `python`."3920 },3921 {3922 "parameter": "testing_criteria[].name",3923 "type": "string",3924 "required": true,3925 "description": "The name of the grader."3926 },3927 {3928 "parameter": "testing_criteria[].source",3929 "type": "string",3930 "required": true,3931 "description": "The source code of the python script."3932 },3933 {3934 "parameter": "testing_criteria[].image_tag",3935 "type": "string",3936 "description": "The image tag to use for the python script."3937 },3938 {3939 "parameter": "testing_criteria[].pass_threshold",3940 "type": "number",3941 "description": "The threshold for the score."3942 },3943 {3944 "parameter": "testing_criteria[].type",3945 "type": "string",3946 "required": true,3947 "enum": [3948 "score_model"3949 ],3950 "description": "The object type, which is always `score_model`."3951 },3952 {3953 "parameter": "testing_criteria[].name",3954 "type": "string",3955 "required": true,3956 "description": "The name of the grader."3957 },3958 {3959 "parameter": "testing_criteria[].model",3960 "type": "string",3961 "required": true,3962 "description": "The model to use for the evaluation."3963 },3964 {3965 "parameter": "testing_criteria[].sampling_params",3966 "type": "object",3967 "description": "The sampling parameters for the model."3968 },3969 {3970 "parameter": "testing_criteria[].sampling_params.seed",3971 "type": "integer | null",3972 "description": ""3973 },3974 {3975 "parameter": "testing_criteria[].sampling_params.top_p",3976 "type": "number | null",3977 "description": ""3978 },3979 {3980 "parameter": "testing_criteria[].sampling_params.temperature",3981 "type": "number | null",3982 "description": ""3983 },3984 {3985 "parameter": "testing_criteria[].sampling_params.max_completions_tokens",3986 "type": "integer | null",3987 "description": ""3988 },3989 {3990 "parameter": "testing_criteria[].sampling_params.reasoning_effort",3991 "type": "object",3992 "description": ""3993 },3994 {3995 "parameter": "testing_criteria[].input",3996 "type": "array<object>",3997 "required": true,3998 "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings."3999 },4000 {4001 "parameter": "testing_criteria[].input[].role",4002 "type": "string",4003 "required": true,4004 "enum": [4005 "user",4006 "assistant",4007 "system",4008 "developer"4009 ],4010 "description": "The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`."4011 },4012 {4013 "parameter": "testing_criteria[].input[].content",4014 "required": true,4015 "type": "object",4016 "description": ""4017 },4018 {4019 "parameter": "testing_criteria[].input[].type",4020 "type": "string",4021 "enum": [4022 "message"4023 ],4024 "description": "The type of the message input. Always `message`."4025 },4026 {4027 "parameter": "testing_criteria[].range",4028 "type": "array<number>",4029 "description": "The range of the score. Defaults to `[0, 1]`."4030 },4031 {4032 "parameter": "testing_criteria[].pass_threshold",4033 "type": "number",4034 "description": "The threshold for the score."4035 },4036 {4037 "parameter": "created_at",4038 "type": "integer",4039 "required": true,4040 "description": "The Unix timestamp (in seconds) for when the eval was created."4041 },4042 {4043 "parameter": "metadata",4044 "type": "object | null",4045 "required": true,4046 "description": ""4047 }4048 ],4049 "status": [4050 "DOCUMENTED",4051 "DEPRECATED"4052 ],4053 "verification": {4054 "method": "docs_only"4055 },4056 "sources": [4057 {4058 "url": "https://developers.openai.com/api/reference/resources/evals",4059 "retrieved_at": "2026-09-18"4060 },4061 {4062 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",4063 "retrieved_at": "2026-09-18"4064 }4065 ]4066 },4067 {4068 "provider": "openai",4069 "api_family": "evals",4070 "name": "EvalRun",4071 "spec_schema": "EvalRun",4072 "object_type": "eval.run",4073 "description": "A schema representing an evaluation run.",4074 "required": [4075 "object",4076 "id",4077 "eval_id",4078 "status",4079 "model",4080 "name",4081 "created_at",4082 "report_url",4083 "result_counts",4084 "per_model_usage",4085 "per_testing_criteria_results",4086 "data_source",4087 "metadata",4088 "error"4089 ],4090 "fields": [4091 {4092 "parameter": "object",4093 "type": "string",4094 "required": true,4095 "enum": [4096 "eval.run"4097 ],4098 "default": "eval.run",4099 "description": "The type of the object. Always \"eval.run\"."4100 },4101 {4102 "parameter": "id",4103 "type": "string",4104 "required": true,4105 "description": "Unique identifier for the evaluation run."4106 },4107 {4108 "parameter": "eval_id",4109 "type": "string",4110 "required": true,4111 "description": "The identifier of the associated evaluation."4112 },4113 {4114 "parameter": "status",4115 "type": "string",4116 "required": true,4117 "description": "The status of the evaluation run."4118 },4119 {4120 "parameter": "model",4121 "type": "string",4122 "required": true,4123 "description": "The model that is evaluated, if applicable."4124 },4125 {4126 "parameter": "name",4127 "type": "string",4128 "required": true,4129 "description": "The name of the evaluation run."4130 },4131 {4132 "parameter": "created_at",4133 "type": "integer",4134 "required": true,4135 "description": "Unix timestamp (in seconds) when the evaluation run was created."4136 },4137 {4138 "parameter": "report_url",4139 "type": "string",4140 "required": true,4141 "description": "The URL to the rendered evaluation run report on the UI dashboard."4142 },4143 {4144 "parameter": "result_counts",4145 "type": "object",4146 "required": true,4147 "description": "Counters summarizing the outcomes of the evaluation run."4148 },4149 {4150 "parameter": "result_counts.total",4151 "type": "integer",4152 "required": true,4153 "description": "Total number of executed output items."4154 },4155 {4156 "parameter": "result_counts.errored",4157 "type": "integer",4158 "required": true,4159 "description": "Number of output items that resulted in an error."4160 },4161 {4162 "parameter": "result_counts.failed",4163 "type": "integer",4164 "required": true,4165 "description": "Number of output items that failed to pass the evaluation."4166 },4167 {4168 "parameter": "result_counts.passed",4169 "type": "integer",4170 "required": true,4171 "description": "Number of output items that passed the evaluation."4172 },4173 {4174 "parameter": "per_model_usage",4175 "type": "array<object>",4176 "required": true,4177 "description": "Usage statistics for each model during the evaluation run."4178 },4179 {4180 "parameter": "per_model_usage[].model_name",4181 "type": "string",4182 "required": true,4183 "description": "The name of the model."4184 },4185 {4186 "parameter": "per_model_usage[].invocation_count",4187 "type": "integer",4188 "required": true,4189 "description": "The number of invocations."4190 },4191 {4192 "parameter": "per_model_usage[].prompt_tokens",4193 "type": "integer",4194 "required": true,4195 "description": "The number of prompt tokens used."4196 },4197 {4198 "parameter": "per_model_usage[].completion_tokens",4199 "type": "integer",4200 "required": true,4201 "description": "The number of completion tokens generated."4202 },4203 {4204 "parameter": "per_model_usage[].total_tokens",4205 "type": "integer",4206 "required": true,4207 "description": "The total number of tokens used."4208 },4209 {4210 "parameter": "per_model_usage[].cached_tokens",4211 "type": "integer",4212 "required": true,4213 "description": "The number of tokens retrieved from cache."4214 },4215 {4216 "parameter": "per_testing_criteria_results",4217 "type": "array<object>",4218 "required": true,4219 "description": "Results per testing criteria applied during the evaluation run."4220 },4221 {4222 "parameter": "per_testing_criteria_results[].testing_criteria",4223 "type": "string",4224 "required": true,4225 "description": "A description of the testing criteria."4226 },4227 {4228 "parameter": "per_testing_criteria_results[].passed",4229 "type": "integer",4230 "required": true,4231 "description": "Number of tests passed for this criteria."4232 },4233 {4234 "parameter": "per_testing_criteria_results[].failed",4235 "type": "integer",4236 "required": true,4237 "description": "Number of tests failed for this criteria."4238 },4239 {4240 "parameter": "data_source",4241 "type": "object",4242 "required": true,4243 "description": "Information about the run's data source."4244 },4245 {4246 "parameter": "data_source.type",4247 "type": "string",4248 "required": true,4249 "enum": [4250 "jsonl"4251 ],4252 "default": "jsonl",4253 "description": "The type of data source. Always `jsonl`."4254 },4255 {4256 "parameter": "data_source.source",4257 "type": "object | object",4258 "required": true,4259 "description": "Determines what populates the `item` namespace in the data source."4260 },4261 {4262 "parameter": "data_source.source.type",4263 "type": "string",4264 "required": true,4265 "enum": [4266 "file_content"4267 ],4268 "default": "file_content",4269 "description": "The type of jsonl source. Always `file_content`."4270 },4271 {4272 "parameter": "data_source.source.content",4273 "type": "array<object>",4274 "required": true,4275 "description": "The content of the jsonl file."4276 },4277 {4278 "parameter": "data_source.source.content[].item",4279 "type": "object",4280 "required": true,4281 "description": ""4282 },4283 {4284 "parameter": "data_source.source.content[].sample",4285 "type": "object",4286 "description": ""4287 },4288 {4289 "parameter": "data_source.source.type",4290 "type": "string",4291 "required": true,4292 "enum": [4293 "file_id"4294 ],4295 "default": "file_id",4296 "description": "The type of jsonl source. Always `file_id`."4297 },4298 {4299 "parameter": "data_source.source.id",4300 "type": "string",4301 "required": true,4302 "description": "The identifier of the file."4303 },4304 {4305 "parameter": "data_source.type",4306 "type": "string",4307 "required": true,4308 "enum": [4309 "completions"4310 ],4311 "default": "completions",4312 "description": "The type of run data source. Always `completions`."4313 },4314 {4315 "parameter": "data_source.input_messages",4316 "type": "object | object",4317 "description": "Used when sampling from a model. Dictates the structure of the messages passed into the model. Can either be a reference to a prebuilt trajectory (ie, `item.input_trajectory`), or a template with variable references to the `item` namespace."4318 },4319 {4320 "parameter": "data_source.input_messages.type",4321 "type": "string",4322 "required": true,4323 "enum": [4324 "template"4325 ],4326 "description": "The type of input messages. Always `template`."4327 },4328 {4329 "parameter": "data_source.input_messages.template",4330 "type": "array<object>",4331 "required": true,4332 "description": "A list of chat messages forming the prompt or context. May include variable references to the `item` namespace, ie {{item.name}}."4333 },4334 {4335 "parameter": "data_source.input_messages.type",4336 "type": "string",4337 "required": true,4338 "enum": [4339 "item_reference"4340 ],4341 "description": "The type of input messages. Always `item_reference`."4342 },4343 {4344 "parameter": "data_source.input_messages.item_reference",4345 "type": "string",4346 "required": true,4347 "description": "A reference to a variable in the `item` namespace. Ie, \"item.input_trajectory\""4348 },4349 {4350 "parameter": "data_source.sampling_params",4351 "type": "object",4352 "description": ""4353 },4354 {4355 "parameter": "data_source.sampling_params.reasoning_effort",4356 "type": "string | null",4357 "description": ""4358 },4359 {4360 "parameter": "data_source.sampling_params.temperature",4361 "type": "number",4362 "default": 1,4363 "description": "A higher temperature increases randomness in the outputs."4364 },4365 {4366 "parameter": "data_source.sampling_params.max_completion_tokens",4367 "type": "integer",4368 "description": "The maximum number of tokens in the generated output."4369 },4370 {4371 "parameter": "data_source.sampling_params.top_p",4372 "type": "number",4373 "default": 1,4374 "description": "An alternative to temperature for nucleus sampling; 1.0 includes all tokens."4375 },4376 {4377 "parameter": "data_source.sampling_params.seed",4378 "type": "integer",4379 "default": 42,4380 "description": "A seed value to initialize the randomness, during sampling."4381 },4382 {4383 "parameter": "data_source.sampling_params.response_format",4384 "type": "object | object | object",4385 "description": "An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](https://developers.openai.com/api/docs/guide"4386 },4387 {4388 "parameter": "data_source.sampling_params.response_format.type",4389 "type": "string",4390 "required": true,4391 "enum": [4392 "text"4393 ],4394 "description": "The type of response format being defined. Always `text`."4395 },4396 {4397 "parameter": "data_source.sampling_params.response_format.type",4398 "type": "string",4399 "required": true,4400 "enum": [4401 "json_schema"4402 ],4403 "description": "The type of response format being defined. Always `json_schema`."4404 },4405 {4406 "parameter": "data_source.sampling_params.response_format.json_schema",4407 "type": "object",4408 "required": true,4409 "description": "Structured Outputs configuration options, including a JSON Schema."4410 },4411 {4412 "parameter": "data_source.sampling_params.response_format.type",4413 "type": "string",4414 "required": true,4415 "enum": [4416 "json_object"4417 ],4418 "description": "The type of response format being defined. Always `json_object`."4419 },4420 {4421 "parameter": "data_source.sampling_params.tools",4422 "type": "array<object>",4423 "description": "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported."4424 },4425 {4426 "parameter": "data_source.sampling_params.tools[].type",4427 "type": "string",4428 "required": true,4429 "enum": [4430 "function"4431 ],4432 "description": "The type of the tool. Currently, only `function` is supported."4433 },4434 {4435 "parameter": "data_source.sampling_params.tools[].function",4436 "required": true,4437 "type": "object",4438 "description": ""4439 },4440 {4441 "parameter": "data_source.model",4442 "type": "string",4443 "description": "The name of the model to use for generating completions (e.g. \"o3-mini\")."4444 },4445 {4446 "parameter": "data_source.source",4447 "type": "object | object | object",4448 "required": true,4449 "description": "Determines what populates the `item` namespace in this run's data source."4450 },4451 {4452 "parameter": "data_source.source.type",4453 "type": "string",4454 "required": true,4455 "enum": [4456 "file_content"4457 ],4458 "default": "file_content",4459 "description": "The type of jsonl source. Always `file_content`."4460 },4461 {4462 "parameter": "data_source.source.content",4463 "type": "array<object>",4464 "required": true,4465 "description": "The content of the jsonl file."4466 },4467 {4468 "parameter": "data_source.source.content[].item",4469 "type": "object",4470 "required": true,4471 "description": ""4472 },4473 {4474 "parameter": "data_source.source.content[].sample",4475 "type": "object",4476 "description": ""4477 },4478 {4479 "parameter": "data_source.source.type",4480 "type": "string",4481 "required": true,4482 "enum": [4483 "file_id"4484 ],4485 "default": "file_id",4486 "description": "The type of jsonl source. Always `file_id`."4487 },4488 {4489 "parameter": "data_source.source.id",4490 "type": "string",4491 "required": true,4492 "description": "The identifier of the file."4493 },4494 {4495 "parameter": "data_source.source.type",4496 "type": "string",4497 "required": true,4498 "enum": [4499 "stored_completions"4500 ],4501 "default": "stored_completions",4502 "description": "The type of source. Always `stored_completions`."4503 },4504 {4505 "parameter": "data_source.source.metadata",4506 "type": "object | null",4507 "description": ""4508 },4509 {4510 "parameter": "data_source.source.model",4511 "type": "string | null",4512 "description": ""4513 },4514 {4515 "parameter": "data_source.source.created_after",4516 "type": "integer | null",4517 "description": ""4518 },4519 {4520 "parameter": "data_source.source.created_before",4521 "type": "integer | null",4522 "description": ""4523 },4524 {4525 "parameter": "data_source.source.limit",4526 "type": "integer | null",4527 "description": ""4528 },4529 {4530 "parameter": "data_source.type",4531 "type": "string",4532 "required": true,4533 "enum": [4534 "responses"4535 ],4536 "default": "responses",4537 "description": "The type of run data source. Always `responses`."4538 },4539 {4540 "parameter": "data_source.input_messages",4541 "type": "object | object",4542 "description": "Used when sampling from a model. Dictates the structure of the messages passed into the model. Can either be a reference to a prebuilt trajectory (ie, `item.input_trajectory`), or a template with variable references to the `item` namespace."4543 },4544 {4545 "parameter": "data_source.input_messages.type",4546 "type": "string",4547 "required": true,4548 "enum": [4549 "template"4550 ],4551 "description": "The type of input messages. Always `template`."4552 },4553 {4554 "parameter": "data_source.input_messages.template",4555 "type": "array<object>",4556 "required": true,4557 "description": "A list of chat messages forming the prompt or context. May include variable references to the `item` namespace, ie {{item.name}}."4558 },4559 {4560 "parameter": "data_source.input_messages.template[].role",4561 "type": "string",4562 "required": true,4563 "description": "The role of the message (e.g. \"system\", \"assistant\", \"user\")."4564 },4565 {4566 "parameter": "data_source.input_messages.template[].content",4567 "type": "string",4568 "required": true,4569 "description": "The content of the message."4570 },4571 {4572 "parameter": "data_source.input_messages.type",4573 "type": "string",4574 "required": true,4575 "enum": [4576 "item_reference"4577 ],4578 "description": "The type of input messages. Always `item_reference`."4579 },4580 {4581 "parameter": "data_source.input_messages.item_reference",4582 "type": "string",4583 "required": true,4584 "description": "A reference to a variable in the `item` namespace. Ie, \"item.name\""4585 },4586 {4587 "parameter": "data_source.sampling_params",4588 "type": "object",4589 "description": ""4590 },4591 {4592 "parameter": "data_source.sampling_params.reasoning_effort",4593 "type": "string | null",4594 "description": ""4595 },4596 {4597 "parameter": "data_source.sampling_params.temperature",4598 "type": "number",4599 "default": 1,4600 "description": "A higher temperature increases randomness in the outputs."4601 },4602 {4603 "parameter": "data_source.sampling_params.max_completion_tokens",4604 "type": "integer",4605 "description": "The maximum number of tokens in the generated output."4606 },4607 {4608 "parameter": "data_source.sampling_params.top_p",4609 "type": "number",4610 "default": 1,4611 "description": "An alternative to temperature for nucleus sampling; 1.0 includes all tokens."4612 },4613 {4614 "parameter": "data_source.sampling_params.seed",4615 "type": "integer",4616 "default": 42,4617 "description": "A seed value to initialize the randomness, during sampling."4618 },4619 {4620 "parameter": "data_source.sampling_params.tools",4621 "type": "array<Tool>",4622 "description": "An array of tools the model may call while generating a response. You\ncan specify which tool to use by setting the `tool_choice` parameter.\n\nThe two categories of tools you can provide the model are:\n\n- **Built-in tools**: Tools that are provided by OpenAI that extend the\n model's capabilities, lik"4623 },4624 {4625 "parameter": "data_source.sampling_params.text",4626 "type": "object",4627 "description": "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)\n- [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)"4628 },4629 {4630 "parameter": "data_source.sampling_params.text.format",4631 "type": "ResponseFormatText | TextResponseFormatJsonSchema | ResponseFormatJsonObject",4632 "description": "An object specifying the format that the model must output.\n\nConfiguring `{ \"type\": \"json_schema\" }` enables Structured Outputs,\nwhich ensures the model will match your supplied JSON schema. Learn more in the\n[Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs"4633 },4634 {4635 "parameter": "data_source.model",4636 "type": "string",4637 "description": "The name of the model to use for generating completions (e.g. \"o3-mini\")."4638 },4639 {4640 "parameter": "data_source.source",4641 "type": "object | object | object",4642 "required": true,4643 "description": "Determines what populates the `item` namespace in this run's data source."4644 },4645 {4646 "parameter": "data_source.source.type",4647 "type": "string",4648 "required": true,4649 "enum": [4650 "file_content"4651 ],4652 "default": "file_content",4653 "description": "The type of jsonl source. Always `file_content`."4654 },4655 {4656 "parameter": "data_source.source.content",4657 "type": "array<object>",4658 "required": true,4659 "description": "The content of the jsonl file."4660 },4661 {4662 "parameter": "data_source.source.content[].item",4663 "type": "object",4664 "required": true,4665 "description": ""4666 },4667 {4668 "parameter": "data_source.source.content[].sample",4669 "type": "object",4670 "description": ""4671 },4672 {4673 "parameter": "data_source.source.type",4674 "type": "string",4675 "required": true,4676 "enum": [4677 "file_id"4678 ],4679 "default": "file_id",4680 "description": "The type of jsonl source. Always `file_id`."4681 },4682 {4683 "parameter": "data_source.source.id",4684 "type": "string",4685 "required": true,4686 "description": "The identifier of the file."4687 },4688 {4689 "parameter": "data_source.source.type",4690 "type": "string",4691 "required": true,4692 "enum": [4693 "responses"4694 ],4695 "description": "The type of run data source. Always `responses`."4696 },4697 {4698 "parameter": "data_source.source.metadata",4699 "type": "object | null",4700 "description": ""4701 },4702 {4703 "parameter": "data_source.source.model",4704 "type": "string | null",4705 "description": ""4706 },4707 {4708 "parameter": "data_source.source.instructions_search",4709 "type": "string | null",4710 "description": ""4711 },4712 {4713 "parameter": "data_source.source.created_after",4714 "type": "integer | null",4715 "description": ""4716 },4717 {4718 "parameter": "data_source.source.created_before",4719 "type": "integer | null",4720 "description": ""4721 },4722 {4723 "parameter": "data_source.source.reasoning_effort",4724 "type": "ReasoningEffort | null",4725 "description": ""4726 },4727 {4728 "parameter": "data_source.source.temperature",4729 "type": "number | null",4730 "description": ""4731 },4732 {4733 "parameter": "data_source.source.top_p",4734 "type": "number | null",4735 "description": ""4736 },4737 {4738 "parameter": "data_source.source.users",4739 "type": "array | null",4740 "description": ""4741 },4742 {4743 "parameter": "data_source.source.tools",4744 "type": "array | null",4745 "description": ""4746 },4747 {4748 "parameter": "metadata",4749 "type": "object | null",4750 "required": true,4751 "description": ""4752 },4753 {4754 "parameter": "error",4755 "type": "object",4756 "required": true,4757 "description": "An object representing an error response from the Eval API."4758 },4759 {4760 "parameter": "error.code",4761 "type": "string",4762 "required": true,4763 "description": "The error code."4764 },4765 {4766 "parameter": "error.message",4767 "type": "string",4768 "required": true,4769 "description": "The error message."4770 }4771 ],4772 "status": [4773 "DOCUMENTED",4774 "DEPRECATED"4775 ],4776 "verification": {4777 "method": "docs_only"4778 },4779 "sources": [4780 {4781 "url": "https://developers.openai.com/api/reference/resources/evals",4782 "retrieved_at": "2026-09-18"4783 },4784 {4785 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",4786 "retrieved_at": "2026-09-18"4787 }4788 ]4789 },4790 {4791 "provider": "openai",4792 "api_family": "evals",4793 "name": "EvalRunOutputItem",4794 "spec_schema": "EvalRunOutputItem",4795 "object_type": "eval.run.output_item",4796 "description": "A schema representing an evaluation run output item.",4797 "required": [4798 "object",4799 "id",4800 "run_id",4801 "eval_id",4802 "created_at",4803 "status",4804 "datasource_item_id",4805 "datasource_item",4806 "results",4807 "sample"4808 ],4809 "fields": [4810 {4811 "parameter": "object",4812 "type": "string",4813 "required": true,4814 "enum": [4815 "eval.run.output_item"4816 ],4817 "default": "eval.run.output_item",4818 "description": "The type of the object. Always \"eval.run.output_item\"."4819 },4820 {4821 "parameter": "id",4822 "type": "string",4823 "required": true,4824 "description": "Unique identifier for the evaluation run output item."4825 },4826 {4827 "parameter": "run_id",4828 "type": "string",4829 "required": true,4830 "description": "The identifier of the evaluation run associated with this output item."4831 },4832 {4833 "parameter": "eval_id",4834 "type": "string",4835 "required": true,4836 "description": "The identifier of the evaluation group."4837 },4838 {4839 "parameter": "created_at",4840 "type": "integer",4841 "required": true,4842 "description": "Unix timestamp (in seconds) when the evaluation run was created."4843 },4844 {4845 "parameter": "status",4846 "type": "string",4847 "required": true,4848 "description": "The status of the evaluation run."4849 },4850 {4851 "parameter": "datasource_item_id",4852 "type": "integer",4853 "required": true,4854 "description": "The identifier for the data source item."4855 },4856 {4857 "parameter": "datasource_item",4858 "type": "object",4859 "required": true,4860 "description": "Details of the input data source item."4861 },4862 {4863 "parameter": "results",4864 "type": "array<object>",4865 "required": true,4866 "description": "A list of grader results for this output item."4867 },4868 {4869 "parameter": "results[].name",4870 "type": "string",4871 "required": true,4872 "description": "The name of the grader."4873 },4874 {4875 "parameter": "results[].type",4876 "type": "string",4877 "description": "The grader type (for example, \"string-check-grader\")."4878 },4879 {4880 "parameter": "results[].score",4881 "type": "number",4882 "required": true,4883 "description": "The numeric score produced by the grader."4884 },4885 {4886 "parameter": "results[].passed",4887 "type": "boolean",4888 "required": true,4889 "description": "Whether the grader considered the output a pass."4890 },4891 {4892 "parameter": "results[].sample",4893 "type": "object | null",4894 "description": "Optional sample or intermediate data produced by the grader."4895 },4896 {4897 "parameter": "sample",4898 "type": "object",4899 "required": true,4900 "description": "A sample containing the input and output of the evaluation run."4901 },4902 {4903 "parameter": "sample.input",4904 "type": "array<object>",4905 "required": true,4906 "description": "An array of input messages."4907 },4908 {4909 "parameter": "sample.input[].role",4910 "type": "string",4911 "required": true,4912 "description": "The role of the message sender (e.g., system, user, developer)."4913 },4914 {4915 "parameter": "sample.input[].content",4916 "type": "string",4917 "required": true,4918 "description": "The content of the message."4919 },4920 {4921 "parameter": "sample.output",4922 "type": "array<object>",4923 "required": true,4924 "description": "An array of output messages."4925 },4926 {4927 "parameter": "sample.output[].role",4928 "type": "string",4929 "description": "The role of the message (e.g. \"system\", \"assistant\", \"user\")."4930 },4931 {4932 "parameter": "sample.output[].content",4933 "type": "string",4934 "description": "The content of the message."4935 },4936 {4937 "parameter": "sample.finish_reason",4938 "type": "string",4939 "required": true,4940 "description": "The reason why the sample generation was finished."4941 },4942 {4943 "parameter": "sample.model",4944 "type": "string",4945 "required": true,4946 "description": "The model used for generating the sample."4947 },4948 {4949 "parameter": "sample.usage",4950 "type": "object",4951 "required": true,4952 "description": "Token usage details for the sample."4953 },4954 {4955 "parameter": "sample.usage.total_tokens",4956 "type": "integer",4957 "required": true,4958 "description": "The total number of tokens used."4959 },4960 {4961 "parameter": "sample.usage.completion_tokens",4962 "type": "integer",4963 "required": true,4964 "description": "The number of completion tokens generated."4965 },4966 {4967 "parameter": "sample.usage.prompt_tokens",4968 "type": "integer",4969 "required": true,4970 "description": "The number of prompt tokens used."4971 },4972 {4973 "parameter": "sample.usage.cached_tokens",4974 "type": "integer",4975 "required": true,4976 "description": "The number of tokens retrieved from cache."4977 },4978 {4979 "parameter": "sample.error",4980 "type": "object",4981 "required": true,4982 "description": "An object representing an error response from the Eval API."4983 },4984 {4985 "parameter": "sample.error.code",4986 "type": "string",4987 "required": true,4988 "description": "The error code."4989 },4990 {4991 "parameter": "sample.error.message",4992 "type": "string",4993 "required": true,4994 "description": "The error message."4995 },4996 {4997 "parameter": "sample.temperature",4998 "type": "number",4999 "required": true,5000 "description": "The sampling temperature used."5001 },5002 {5003 "parameter": "sample.max_completion_tokens",5004 "type": "integer",5005 "required": true,5006 "description": "The maximum number of tokens allowed for completion."5007 },5008 {5009 "parameter": "sample.top_p",5010 "type": "number",5011 "required": true,5012 "description": "The top_p value used for sampling."5013 },5014 {5015 "parameter": "sample.seed",5016 "type": "integer",5017 "required": true,5018 "description": "The seed used for generating the sample."5019 }5020 ],5021 "status": [5022 "DOCUMENTED",5023 "DEPRECATED"5024 ],5025 "verification": {5026 "method": "docs_only"5027 },5028 "sources": [5029 {5030 "url": "https://developers.openai.com/api/reference/resources/evals",5031 "retrieved_at": "2026-09-18"5032 },5033 {5034 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",5035 "retrieved_at": "2026-09-18"5036 }5037 ]5038 },5039 {5040 "provider": "openai",5041 "api_family": "evals",5042 "name": "EvalRunOutputItemResult",5043 "spec_schema": "EvalRunOutputItemResult",5044 "object_type": null,5045 "description": "A single grader result for an evaluation run output item.",5046 "required": [5047 "name",5048 "score",5049 "passed"5050 ],5051 "fields": [5052 {5053 "parameter": "name",5054 "type": "string",5055 "required": true,5056 "description": "The name of the grader."5057 },5058 {5059 "parameter": "type",5060 "type": "string",5061 "description": "The grader type (for example, \"string-check-grader\")."5062 },5063 {5064 "parameter": "score",5065 "type": "number",5066 "required": true,5067 "description": "The numeric score produced by the grader."5068 },5069 {5070 "parameter": "passed",5071 "type": "boolean",5072 "required": true,5073 "description": "Whether the grader considered the output a pass."5074 },5075 {5076 "parameter": "sample",5077 "type": "object | null",5078 "description": "Optional sample or intermediate data produced by the grader."5079 }5080 ],5081 "status": [5082 "DOCUMENTED",5083 "DEPRECATED"5084 ],5085 "verification": {5086 "method": "docs_only"5087 },5088 "sources": [5089 {5090 "url": "https://developers.openai.com/api/reference/resources/evals",5091 "retrieved_at": "2026-09-18"5092 },5093 {5094 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",5095 "retrieved_at": "2026-09-18"5096 }5097 ]5098 },5099 {5100 "provider": "openai",5101 "api_family": "evals",5102 "name": "EvalApiError",5103 "spec_schema": "EvalApiError",5104 "object_type": null,5105 "description": "An object representing an error response from the Eval API.",5106 "required": [5107 "code",5108 "message"5109 ],5110 "fields": [5111 {5112 "parameter": "code",5113 "type": "string",5114 "required": true,5115 "description": "The error code."5116 },5117 {5118 "parameter": "message",5119 "type": "string",5120 "required": true,5121 "description": "The error message."5122 }5123 ],5124 "status": [5125 "DOCUMENTED",5126 "DEPRECATED"5127 ],5128 "verification": {5129 "method": "docs_only"5130 },5131 "sources": [5132 {5133 "url": "https://developers.openai.com/api/reference/resources/evals",5134 "retrieved_at": "2026-09-18"5135 },5136 {5137 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",5138 "retrieved_at": "2026-09-18"5139 }5140 ]5141 },5142 {5143 "provider": "openai",5144 "api_family": "files",5145 "name": "ListFilesResponse",5146 "spec_schema": "ListFilesResponse",5147 "object_type": "list",5148 "description": "",5149 "required": [5150 "object",5151 "data",5152 "first_id",5153 "last_id",5154 "has_more"5155 ],5156 "fields": [5157 {5158 "parameter": "object",5159 "type": "string",5160 "required": true,5161 "description": ""5162 },5163 {5164 "parameter": "data",5165 "type": "array<OpenAIFile>",5166 "required": true,5167 "description": ""5168 },5169 {5170 "parameter": "data[].id",5171 "type": "string",5172 "required": true,5173 "description": "The file identifier, which can be referenced in the API endpoints."5174 },5175 {5176 "parameter": "data[].bytes",5177 "type": "integer",5178 "required": true,5179 "description": "The size of the file, in bytes."5180 },5181 {5182 "parameter": "data[].created_at",5183 "type": "integer",5184 "required": true,5185 "description": "The Unix timestamp (in seconds) for when the file was created."5186 },5187 {5188 "parameter": "data[].expires_at",5189 "type": "integer",5190 "description": "The Unix timestamp (in seconds) for when the file will expire."5191 },5192 {5193 "parameter": "data[].filename",5194 "type": "string",5195 "required": true,5196 "description": "The name of the file."5197 },5198 {5199 "parameter": "data[].object",5200 "type": "string",5201 "required": true,5202 "enum": [5203 "file"5204 ],5205 "description": "The object type, which is always `file`."5206 },5207 {5208 "parameter": "data[].purpose",5209 "type": "string",5210 "required": true,5211 "enum": [5212 "assistants",5213 "assistants_output",5214 "batch",5215 "batch_output",5216 "fine-tune",5217 "fine-tune-results",5218 "vision",5219 "user_data"5220 ],5221 "description": "The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `vision`, and `user_data`."5222 },5223 {5224 "parameter": "data[].status",5225 "type": "string",5226 "required": true,5227 "enum": [5228 "uploaded",5229 "processed",5230 "error"5231 ],5232 "description": "Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`."5233 },5234 {5235 "parameter": "data[].status_details",5236 "type": "string",5237 "description": "Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`."5238 },5239 {5240 "parameter": "first_id",5241 "type": "string",5242 "required": true,5243 "description": ""5244 },5245 {5246 "parameter": "last_id",5247 "type": "string",5248 "required": true,5249 "description": ""5250 },5251 {5252 "parameter": "has_more",5253 "type": "boolean",5254 "required": true,5255 "description": ""5256 }5257 ],5258 "status": [5259 "DOCUMENTED"5260 ],5261 "verification": {5262 "method": "docs_only"5263 },5264 "sources": [5265 {5266 "url": "https://developers.openai.com/api/reference/resources/files",5267 "retrieved_at": "2026-09-18"5268 },5269 {5270 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",5271 "retrieved_at": "2026-09-18"5272 }5273 ]5274 },5275 {5276 "provider": "openai",5277 "api_family": "batches",5278 "name": "ListBatchesResponse",5279 "spec_schema": "ListBatchesResponse",5280 "object_type": "list",5281 "description": "",5282 "required": [5283 "object",5284 "data",5285 "has_more"5286 ],5287 "fields": [5288 {5289 "parameter": "data",5290 "type": "array<object>",5291 "required": true,5292 "description": ""5293 },5294 {5295 "parameter": "data[].id",5296 "type": "string",5297 "required": true,5298 "description": ""5299 },5300 {5301 "parameter": "data[].object",5302 "type": "string",5303 "required": true,5304 "enum": [5305 "batch"5306 ],5307 "description": "The object type, which is always `batch`."5308 },5309 {5310 "parameter": "data[].endpoint",5311 "type": "string",5312 "required": true,5313 "description": "The OpenAI API endpoint used by the batch."5314 },5315 {5316 "parameter": "data[].model",5317 "type": "string",5318 "description": "Model ID used to process the batch, like `gpt-6-astra`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model\nguide](https://developers.openai.com/api/docs/models) to browse and compare available models."5319 },5320 {5321 "parameter": "data[].errors",5322 "type": "object",5323 "description": ""5324 },5325 {5326 "parameter": "data[].errors.object",5327 "type": "string",5328 "description": "The object type, which is always `list`."5329 },5330 {5331 "parameter": "data[].errors.data",5332 "type": "array<object>",5333 "description": ""5334 },5335 {5336 "parameter": "data[].errors.data[].code",5337 "type": "string",5338 "description": "An error code identifying the error type."5339 },5340 {5341 "parameter": "data[].errors.data[].message",5342 "type": "string",5343 "description": "A human-readable message providing more details about the error."5344 },5345 {5346 "parameter": "data[].errors.data[].param",5347 "type": "string | null",5348 "description": ""5349 },5350 {5351 "parameter": "data[].errors.data[].line",5352 "type": "integer | null",5353 "description": ""5354 },5355 {5356 "parameter": "data[].input_file_id",5357 "type": "string",5358 "required": true,5359 "description": "The ID of the input file for the batch."5360 },5361 {5362 "parameter": "data[].completion_window",5363 "type": "string",5364 "required": true,5365 "description": "The time frame within which the batch should be processed."5366 },5367 {5368 "parameter": "data[].status",5369 "type": "string",5370 "required": true,5371 "enum": [5372 "validating",5373 "failed",5374 "in_progress",5375 "finalizing",5376 "completed",5377 "expired",5378 "cancelling",5379 "cancelled"5380 ],5381 "description": "The current status of the batch."5382 },5383 {5384 "parameter": "data[].output_file_id",5385 "type": "string",5386 "description": "The ID of the file containing the outputs of successfully executed requests."5387 },5388 {5389 "parameter": "data[].error_file_id",5390 "type": "string",5391 "description": "The ID of the file containing the outputs of requests with errors."5392 },5393 {5394 "parameter": "data[].created_at",5395 "type": "integer",5396 "required": true,5397 "description": "The Unix timestamp (in seconds) for when the batch was created."5398 },5399 {5400 "parameter": "data[].in_progress_at",5401 "type": "integer",5402 "description": "The Unix timestamp (in seconds) for when the batch started processing."5403 },5404 {5405 "parameter": "data[].expires_at",5406 "type": "integer",5407 "description": "The Unix timestamp (in seconds) for when the batch will expire."5408 },5409 {5410 "parameter": "data[].finalizing_at",5411 "type": "integer",5412 "description": "The Unix timestamp (in seconds) for when the batch started finalizing."5413 },5414 {5415 "parameter": "data[].completed_at",5416 "type": "integer",5417 "description": "The Unix timestamp (in seconds) for when the batch was completed."5418 },5419 {5420 "parameter": "data[].failed_at",5421 "type": "integer",5422 "description": "The Unix timestamp (in seconds) for when the batch failed."5423 },5424 {5425 "parameter": "data[].expired_at",5426 "type": "integer",5427 "description": "The Unix timestamp (in seconds) for when the batch expired."5428 },5429 {5430 "parameter": "data[].cancelling_at",5431 "type": "integer",5432 "description": "The Unix timestamp (in seconds) for when the batch started cancelling."5433 },5434 {5435 "parameter": "data[].cancelled_at",5436 "type": "integer",5437 "description": "The Unix timestamp (in seconds) for when the batch was cancelled."5438 },5439 {5440 "parameter": "data[].request_counts",5441 "type": "object",5442 "description": "The request counts for different statuses within the batch."5443 },5444 {5445 "parameter": "data[].request_counts.total",5446 "type": "integer",5447 "required": true,5448 "description": "Total number of requests in the batch."5449 },5450 {5451 "parameter": "data[].request_counts.completed",5452 "type": "integer",5453 "required": true,5454 "description": "Number of requests that have been completed successfully."5455 },5456 {5457 "parameter": "data[].request_counts.failed",5458 "type": "integer",5459 "required": true,5460 "description": "Number of requests that have failed."5461 },5462 {5463 "parameter": "data[].usage",5464 "type": "object",5465 "description": "Represents token usage details including input tokens, output tokens, a\nbreakdown of output tokens, and the total tokens used. Only populated on\nbatches created after September 7, 2025."5466 },5467 {5468 "parameter": "data[].usage.input_tokens",5469 "type": "integer",5470 "required": true,5471 "description": "The number of input tokens."5472 },5473 {5474 "parameter": "data[].usage.input_tokens_details",5475 "type": "object",5476 "required": true,5477 "description": "A detailed breakdown of the input tokens."5478 },5479 {5480 "parameter": "data[].usage.input_tokens_details.cached_tokens",5481 "type": "integer",5482 "required": true,5483 "description": "The number of tokens that were retrieved from the cache. [More on\nprompt caching](https://developers.openai.com/api/docs/guides/prompt-caching)."5484 },5485 {5486 "parameter": "data[].usage.output_tokens",5487 "type": "integer",5488 "required": true,5489 "description": "The number of output tokens."5490 },5491 {5492 "parameter": "data[].usage.output_tokens_details",5493 "type": "object",5494 "required": true,5495 "description": "A detailed breakdown of the output tokens."5496 },5497 {5498 "parameter": "data[].usage.output_tokens_details.reasoning_tokens",5499 "type": "integer",5500 "required": true,5501 "description": "The number of reasoning tokens."5502 },5503 {5504 "parameter": "data[].usage.total_tokens",5505 "type": "integer",5506 "required": true,5507 "description": "The total number of tokens used."5508 },5509 {5510 "parameter": "data[].metadata",5511 "type": "object | null",5512 "description": ""5513 },5514 {5515 "parameter": "first_id",5516 "type": "string",5517 "description": ""5518 },5519 {5520 "parameter": "last_id",5521 "type": "string",5522 "description": ""5523 },5524 {5525 "parameter": "has_more",5526 "type": "boolean",5527 "required": true,5528 "description": ""5529 },5530 {5531 "parameter": "object",5532 "type": "string",5533 "required": true,5534 "enum": [5535 "list"5536 ],5537 "description": ""5538 }5539 ],5540 "status": [5541 "DOCUMENTED"5542 ],5543 "verification": {5544 "method": "docs_only"5545 },5546 "sources": [5547 {5548 "url": "https://developers.openai.com/api/reference/resources/batches",5549 "retrieved_at": "2026-09-18"5550 },5551 {5552 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",5553 "retrieved_at": "2026-09-18"5554 }5555 ]5556 },5557 {5558 "provider": "openai",5559 "api_family": "evals",5560 "name": "EvalList",5561 "spec_schema": "EvalList",5562 "object_type": "list",5563 "description": "An object representing a list of evals.",5564 "required": [5565 "object",5566 "data",5567 "first_id",5568 "last_id",5569 "has_more"5570 ],5571 "fields": [5572 {5573 "parameter": "object",5574 "type": "string",5575 "required": true,5576 "enum": [5577 "list"5578 ],5579 "default": "list",5580 "description": "The type of this object. It is always set to \"list\"."5581 },5582 {5583 "parameter": "data",5584 "type": "array<object>",5585 "required": true,5586 "description": "An array of eval objects."5587 },5588 {5589 "parameter": "data[].object",5590 "type": "string",5591 "required": true,5592 "enum": [5593 "eval"5594 ],5595 "default": "eval",5596 "description": "The object type."5597 },5598 {5599 "parameter": "data[].id",5600 "type": "string",5601 "required": true,5602 "description": "Unique identifier for the evaluation."5603 },5604 {5605 "parameter": "data[].name",5606 "type": "string",5607 "required": true,5608 "description": "The name of the evaluation."5609 },5610 {5611 "parameter": "data[].data_source_config",5612 "type": "object",5613 "required": true,5614 "description": "Configuration of data sources used in runs of the evaluation."5615 },5616 {5617 "parameter": "data[].data_source_config.type",5618 "type": "string",5619 "required": true,5620 "enum": [5621 "custom"5622 ],5623 "default": "custom",5624 "description": "The type of data source. Always `custom`."5625 },5626 {5627 "parameter": "data[].data_source_config.schema",5628 "type": "object",5629 "required": true,5630 "description": "The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/)."5631 },5632 {5633 "parameter": "data[].data_source_config.type",5634 "type": "string",5635 "required": true,5636 "enum": [5637 "logs"5638 ],5639 "default": "logs",5640 "description": "The type of data source. Always `logs`."5641 },5642 {5643 "parameter": "data[].data_source_config.metadata",5644 "type": "object | null",5645 "description": ""5646 },5647 {5648 "parameter": "data[].data_source_config.schema",5649 "type": "object",5650 "required": true,5651 "description": "The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/)."5652 },5653 {5654 "parameter": "data[].data_source_config.type",5655 "type": "string",5656 "required": true,5657 "enum": [5658 "stored_completions"5659 ],5660 "default": "stored_completions",5661 "description": "The type of data source. Always `stored_completions`."5662 },5663 {5664 "parameter": "data[].data_source_config.metadata",5665 "type": "object | null",5666 "description": ""5667 },5668 {5669 "parameter": "data[].data_source_config.schema",5670 "type": "object",5671 "required": true,5672 "description": "The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/)."5673 },5674 {5675 "parameter": "data[].testing_criteria",5676 "type": "array<object>",5677 "required": true,5678 "description": "A list of testing criteria."5679 },5680 {5681 "parameter": "data[].testing_criteria[].type",5682 "type": "string",5683 "required": true,5684 "enum": [5685 "label_model"5686 ],5687 "description": "The object type, which is always `label_model`."5688 },5689 {5690 "parameter": "data[].testing_criteria[].name",5691 "type": "string",5692 "required": true,5693 "description": "The name of the grader."5694 },5695 {5696 "parameter": "data[].testing_criteria[].model",5697 "type": "string",5698 "required": true,5699 "description": "The model to use for the evaluation. Must support structured outputs."5700 },5701 {5702 "parameter": "data[].testing_criteria[].input",5703 "type": "array<EvalItem>",5704 "required": true,5705 "description": ""5706 },5707 {5708 "parameter": "data[].testing_criteria[].labels",5709 "type": "array<string>",5710 "required": true,5711 "description": "The labels to assign to each item in the evaluation."5712 },5713 {5714 "parameter": "data[].testing_criteria[].passing_labels",5715 "type": "array<string>",5716 "required": true,5717 "description": "The labels that indicate a passing result. Must be a subset of labels."5718 },5719 {5720 "parameter": "data[].testing_criteria[].type",5721 "type": "string",5722 "required": true,5723 "enum": [5724 "string_check"5725 ],5726 "description": "The object type, which is always `string_check`."5727 },5728 {5729 "parameter": "data[].testing_criteria[].name",5730 "type": "string",5731 "required": true,5732 "description": "The name of the grader."5733 },5734 {5735 "parameter": "data[].testing_criteria[].input",5736 "type": "string",5737 "required": true,5738 "description": "The input text. This may include template strings."5739 },5740 {5741 "parameter": "data[].testing_criteria[].reference",5742 "type": "string",5743 "required": true,5744 "description": "The reference text. This may include template strings."5745 },5746 {5747 "parameter": "data[].testing_criteria[].operation",5748 "type": "string",5749 "required": true,5750 "enum": [5751 "eq",5752 "ne",5753 "like",5754 "ilike"5755 ],5756 "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`."5757 },5758 {5759 "parameter": "data[].testing_criteria[].type",5760 "type": "string",5761 "required": true,5762 "enum": [5763 "text_similarity"5764 ],5765 "default": "text_similarity",5766 "description": "The type of grader."5767 },5768 {5769 "parameter": "data[].testing_criteria[].name",5770 "type": "string",5771 "required": true,5772 "description": "The name of the grader."5773 },5774 {5775 "parameter": "data[].testing_criteria[].input",5776 "type": "string",5777 "required": true,5778 "description": "The text being graded."5779 },5780 {5781 "parameter": "data[].testing_criteria[].reference",5782 "type": "string",5783 "required": true,5784 "description": "The text being graded against."5785 },5786 {5787 "parameter": "data[].testing_criteria[].evaluation_metric",5788 "type": "string",5789 "required": true,5790 "enum": [5791 "cosine",5792 "fuzzy_match",5793 "bleu",5794 "gleu",5795 "meteor",5796 "rouge_1",5797 "rouge_2",5798 "rouge_3",5799 "rouge_4",5800 "rouge_5",5801 "rouge_l"5802 ],5803 "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`."5804 },5805 {5806 "parameter": "data[].testing_criteria[].pass_threshold",5807 "type": "number",5808 "required": true,5809 "description": "The threshold for the score."5810 },5811 {5812 "parameter": "data[].testing_criteria[].type",5813 "type": "string",5814 "required": true,5815 "enum": [5816 "python"5817 ],5818 "description": "The object type, which is always `python`."5819 },5820 {5821 "parameter": "data[].testing_criteria[].name",5822 "type": "string",5823 "required": true,5824 "description": "The name of the grader."5825 },5826 {5827 "parameter": "data[].testing_criteria[].source",5828 "type": "string",5829 "required": true,5830 "description": "The source code of the python script."5831 },5832 {5833 "parameter": "data[].testing_criteria[].image_tag",5834 "type": "string",5835 "description": "The image tag to use for the python script."5836 },5837 {5838 "parameter": "data[].testing_criteria[].pass_threshold",5839 "type": "number",5840 "description": "The threshold for the score."5841 },5842 {5843 "parameter": "data[].testing_criteria[].type",5844 "type": "string",5845 "required": true,5846 "enum": [5847 "score_model"5848 ],5849 "description": "The object type, which is always `score_model`."5850 },5851 {5852 "parameter": "data[].testing_criteria[].name",5853 "type": "string",5854 "required": true,5855 "description": "The name of the grader."5856 },5857 {5858 "parameter": "data[].testing_criteria[].model",5859 "type": "string",5860 "required": true,5861 "description": "The model to use for the evaluation."5862 },5863 {5864 "parameter": "data[].testing_criteria[].sampling_params",5865 "type": "object",5866 "description": "The sampling parameters for the model."5867 },5868 {5869 "parameter": "data[].testing_criteria[].sampling_params.seed",5870 "type": "integer | null",5871 "description": ""5872 },5873 {5874 "parameter": "data[].testing_criteria[].sampling_params.top_p",5875 "type": "number | null",5876 "description": ""5877 },5878 {5879 "parameter": "data[].testing_criteria[].sampling_params.temperature",5880 "type": "number | null",5881 "description": ""5882 },5883 {5884 "parameter": "data[].testing_criteria[].sampling_params.max_completions_tokens",5885 "type": "integer | null",5886 "description": ""5887 },5888 {5889 "parameter": "data[].testing_criteria[].sampling_params.reasoning_effort",5890 "type": "object",5891 "description": ""5892 },5893 {5894 "parameter": "data[].testing_criteria[].input",5895 "type": "array<EvalItem>",5896 "required": true,5897 "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings."5898 },5899 {5900 "parameter": "data[].testing_criteria[].range",5901 "type": "array<number>",5902 "description": "The range of the score. Defaults to `[0, 1]`."5903 },5904 {5905 "parameter": "data[].testing_criteria[].pass_threshold",5906 "type": "number",5907 "description": "The threshold for the score."5908 },5909 {5910 "parameter": "data[].created_at",5911 "type": "integer",5912 "required": true,5913 "description": "The Unix timestamp (in seconds) for when the eval was created."5914 },5915 {5916 "parameter": "data[].metadata",5917 "type": "object | null",5918 "required": true,5919 "description": ""5920 },5921 {5922 "parameter": "first_id",5923 "type": "string",5924 "required": true,5925 "description": "The identifier of the first eval in the data array."5926 },5927 {5928 "parameter": "last_id",5929 "type": "string",5930 "required": true,5931 "description": "The identifier of the last eval in the data array."5932 },5933 {5934 "parameter": "has_more",5935 "type": "boolean",5936 "required": true,5937 "description": "Indicates whether there are more evals available."5938 }5939 ],5940 "status": [5941 "DOCUMENTED",5942 "DEPRECATED"5943 ],5944 "verification": {5945 "method": "docs_only"5946 },5947 "sources": [5948 {5949 "url": "https://developers.openai.com/api/reference/resources/evals",5950 "retrieved_at": "2026-09-18"5951 },5952 {5953 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",5954 "retrieved_at": "2026-09-18"5955 }5956 ]5957 },5958 {5959 "provider": "openai",5960 "api_family": "evals",5961 "name": "EvalRunList",5962 "spec_schema": "EvalRunList",5963 "object_type": "list",5964 "description": "An object representing a list of runs for an evaluation.",5965 "required": [5966 "object",5967 "data",5968 "first_id",5969 "last_id",5970 "has_more"5971 ],5972 "fields": [5973 {5974 "parameter": "object",5975 "type": "string",5976 "required": true,5977 "enum": [5978 "list"5979 ],5980 "default": "list",5981 "description": "The type of this object. It is always set to \"list\"."5982 },5983 {5984 "parameter": "data",5985 "type": "array<object>",5986 "required": true,5987 "description": "An array of eval run objects."5988 },5989 {5990 "parameter": "data[].object",5991 "type": "string",5992 "required": true,5993 "enum": [5994 "eval.run"5995 ],5996 "default": "eval.run",5997 "description": "The type of the object. Always \"eval.run\"."5998 },5999 {6000 "parameter": "data[].id",6001 "type": "string",6002 "required": true,6003 "description": "Unique identifier for the evaluation run."6004 },6005 {6006 "parameter": "data[].eval_id",6007 "type": "string",6008 "required": true,6009 "description": "The identifier of the associated evaluation."6010 },6011 {6012 "parameter": "data[].status",6013 "type": "string",6014 "required": true,6015 "description": "The status of the evaluation run."6016 },6017 {6018 "parameter": "data[].model",6019 "type": "string",6020 "required": true,6021 "description": "The model that is evaluated, if applicable."6022 },6023 {6024 "parameter": "data[].name",6025 "type": "string",6026 "required": true,6027 "description": "The name of the evaluation run."6028 },6029 {6030 "parameter": "data[].created_at",6031 "type": "integer",6032 "required": true,6033 "description": "Unix timestamp (in seconds) when the evaluation run was created."6034 },6035 {6036 "parameter": "data[].report_url",6037 "type": "string",6038 "required": true,6039 "description": "The URL to the rendered evaluation run report on the UI dashboard."6040 },6041 {6042 "parameter": "data[].result_counts",6043 "type": "object",6044 "required": true,6045 "description": "Counters summarizing the outcomes of the evaluation run."6046 },6047 {6048 "parameter": "data[].result_counts.total",6049 "type": "integer",6050 "required": true,6051 "description": "Total number of executed output items."6052 },6053 {6054 "parameter": "data[].result_counts.errored",6055 "type": "integer",6056 "required": true,6057 "description": "Number of output items that resulted in an error."6058 },6059 {6060 "parameter": "data[].result_counts.failed",6061 "type": "integer",6062 "required": true,6063 "description": "Number of output items that failed to pass the evaluation."6064 },6065 {6066 "parameter": "data[].result_counts.passed",6067 "type": "integer",6068 "required": true,6069 "description": "Number of output items that passed the evaluation."6070 },6071 {6072 "parameter": "data[].per_model_usage",6073 "type": "array<object>",6074 "required": true,6075 "description": "Usage statistics for each model during the evaluation run."6076 },6077 {6078 "parameter": "data[].per_model_usage[].model_name",6079 "type": "string",6080 "required": true,6081 "description": "The name of the model."6082 },6083 {6084 "parameter": "data[].per_model_usage[].invocation_count",6085 "type": "integer",6086 "required": true,6087 "description": "The number of invocations."6088 },6089 {6090 "parameter": "data[].per_model_usage[].prompt_tokens",6091 "type": "integer",6092 "required": true,6093 "description": "The number of prompt tokens used."6094 },6095 {6096 "parameter": "data[].per_model_usage[].completion_tokens",6097 "type": "integer",6098 "required": true,6099 "description": "The number of completion tokens generated."6100 },6101 {6102 "parameter": "data[].per_model_usage[].total_tokens",6103 "type": "integer",6104 "required": true,6105 "description": "The total number of tokens used."6106 },6107 {6108 "parameter": "data[].per_model_usage[].cached_tokens",6109 "type": "integer",6110 "required": true,6111 "description": "The number of tokens retrieved from cache."6112 },6113 {6114 "parameter": "data[].per_testing_criteria_results",6115 "type": "array<object>",6116 "required": true,6117 "description": "Results per testing criteria applied during the evaluation run."6118 },6119 {6120 "parameter": "data[].per_testing_criteria_results[].testing_criteria",6121 "type": "string",6122 "required": true,6123 "description": "A description of the testing criteria."6124 },6125 {6126 "parameter": "data[].per_testing_criteria_results[].passed",6127 "type": "integer",6128 "required": true,6129 "description": "Number of tests passed for this criteria."6130 },6131 {6132 "parameter": "data[].per_testing_criteria_results[].failed",6133 "type": "integer",6134 "required": true,6135 "description": "Number of tests failed for this criteria."6136 },6137 {6138 "parameter": "data[].data_source",6139 "type": "object",6140 "required": true,6141 "description": "Information about the run's data source."6142 },6143 {6144 "parameter": "data[].data_source.type",6145 "type": "string",6146 "required": true,6147 "enum": [6148 "jsonl"6149 ],6150 "default": "jsonl",6151 "description": "The type of data source. Always `jsonl`."6152 },6153 {6154 "parameter": "data[].data_source.source",6155 "type": "EvalJsonlFileContentSource | EvalJsonlFileIdSource",6156 "required": true,6157 "description": "Determines what populates the `item` namespace in the data source."6158 },6159 {6160 "parameter": "data[].data_source.type",6161 "type": "string",6162 "required": true,6163 "enum": [6164 "completions"6165 ],6166 "default": "completions",6167 "description": "The type of run data source. Always `completions`."6168 },6169 {6170 "parameter": "data[].data_source.input_messages",6171 "type": "object | object",6172 "description": "Used when sampling from a model. Dictates the structure of the messages passed into the model. Can either be a reference to a prebuilt trajectory (ie, `item.input_trajectory`), or a template with variable references to the `item` namespace."6173 },6174 {6175 "parameter": "data[].data_source.input_messages.type",6176 "type": "string",6177 "required": true,6178 "enum": [6179 "template"6180 ],6181 "description": "The type of input messages. Always `template`."6182 },6183 {6184 "parameter": "data[].data_source.input_messages.template",6185 "type": "array<object>",6186 "required": true,6187 "description": "A list of chat messages forming the prompt or context. May include variable references to the `item` namespace, ie {{item.name}}."6188 },6189 {6190 "parameter": "data[].data_source.input_messages.type",6191 "type": "string",6192 "required": true,6193 "enum": [6194 "item_reference"6195 ],6196 "description": "The type of input messages. Always `item_reference`."6197 },6198 {6199 "parameter": "data[].data_source.input_messages.item_reference",6200 "type": "string",6201 "required": true,6202 "description": "A reference to a variable in the `item` namespace. Ie, \"item.input_trajectory\""6203 },6204 {6205 "parameter": "data[].data_source.sampling_params",6206 "type": "object",6207 "description": ""6208 },6209 {6210 "parameter": "data[].data_source.sampling_params.reasoning_effort",6211 "type": "object",6212 "description": ""6213 },6214 {6215 "parameter": "data[].data_source.sampling_params.temperature",6216 "type": "number",6217 "default": 1,6218 "description": "A higher temperature increases randomness in the outputs."6219 },6220 {6221 "parameter": "data[].data_source.sampling_params.max_completion_tokens",6222 "type": "integer",6223 "description": "The maximum number of tokens in the generated output."6224 },6225 {6226 "parameter": "data[].data_source.sampling_params.top_p",6227 "type": "number",6228 "default": 1,6229 "description": "An alternative to temperature for nucleus sampling; 1.0 includes all tokens."6230 },6231 {6232 "parameter": "data[].data_source.sampling_params.seed",6233 "type": "integer",6234 "default": 42,6235 "description": "A seed value to initialize the randomness, during sampling."6236 },6237 {6238 "parameter": "data[].data_source.sampling_params.response_format",6239 "type": "ResponseFormatText | ResponseFormatJsonSchema | ResponseFormatJsonObject",6240 "description": "An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](https://developers.openai.com/api/docs/guide"6241 },6242 {6243 "parameter": "data[].data_source.sampling_params.tools",6244 "type": "array<ChatCompletionTool>",6245 "description": "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported."6246 },6247 {6248 "parameter": "data[].data_source.model",6249 "type": "string",6250 "description": "The name of the model to use for generating completions (e.g. \"o3-mini\")."6251 },6252 {6253 "parameter": "data[].data_source.source",6254 "type": "EvalJsonlFileContentSource | EvalJsonlFileIdSource | EvalStoredCompletionsSource",6255 "required": true,6256 "description": "Determines what populates the `item` namespace in this run's data source."6257 },6258 {6259 "parameter": "data[].data_source.type",6260 "type": "string",6261 "required": true,6262 "enum": [6263 "responses"6264 ],6265 "default": "responses",6266 "description": "The type of run data source. Always `responses`."6267 },6268 {6269 "parameter": "data[].data_source.input_messages",6270 "type": "object | object",6271 "description": "Used when sampling from a model. Dictates the structure of the messages passed into the model. Can either be a reference to a prebuilt trajectory (ie, `item.input_trajectory`), or a template with variable references to the `item` namespace."6272 },6273 {6274 "parameter": "data[].data_source.input_messages.type",6275 "type": "string",6276 "required": true,6277 "enum": [6278 "template"6279 ],6280 "description": "The type of input messages. Always `template`."6281 },6282 {6283 "parameter": "data[].data_source.input_messages.template",6284 "type": "array<object>",6285 "required": true,6286 "description": "A list of chat messages forming the prompt or context. May include variable references to the `item` namespace, ie {{item.name}}."6287 },6288 {6289 "parameter": "data[].data_source.input_messages.type",6290 "type": "string",6291 "required": true,6292 "enum": [6293 "item_reference"6294 ],6295 "description": "The type of input messages. Always `item_reference`."6296 },6297 {6298 "parameter": "data[].data_source.input_messages.item_reference",6299 "type": "string",6300 "required": true,6301 "description": "A reference to a variable in the `item` namespace. Ie, \"item.name\""6302 },6303 {6304 "parameter": "data[].data_source.sampling_params",6305 "type": "object",6306 "description": ""6307 },6308 {6309 "parameter": "data[].data_source.sampling_params.reasoning_effort",6310 "type": "object",6311 "description": ""6312 },6313 {6314 "parameter": "data[].data_source.sampling_params.temperature",6315 "type": "number",6316 "default": 1,6317 "description": "A higher temperature increases randomness in the outputs."6318 },6319 {6320 "parameter": "data[].data_source.sampling_params.max_completion_tokens",6321 "type": "integer",6322 "description": "The maximum number of tokens in the generated output."6323 },6324 {6325 "parameter": "data[].data_source.sampling_params.top_p",6326 "type": "number",6327 "default": 1,6328 "description": "An alternative to temperature for nucleus sampling; 1.0 includes all tokens."6329 },6330 {6331 "parameter": "data[].data_source.sampling_params.seed",6332 "type": "integer",6333 "default": 42,6334 "description": "A seed value to initialize the randomness, during sampling."6335 },6336 {6337 "parameter": "data[].data_source.sampling_params.tools",6338 "type": "array<Tool>",6339 "description": "An array of tools the model may call while generating a response. You\ncan specify which tool to use by setting the `tool_choice` parameter.\n\nThe two categories of tools you can provide the model are:\n\n- **Built-in tools**: Tools that are provided by OpenAI that extend the\n model's capabilities, lik"6340 },6341 {6342 "parameter": "data[].data_source.sampling_params.text",6343 "type": "object",6344 "description": "Configuration options for a text response from the model. Can be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)\n- [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)"6345 },6346 {6347 "parameter": "data[].data_source.model",6348 "type": "string",6349 "description": "The name of the model to use for generating completions (e.g. \"o3-mini\")."6350 },6351 {6352 "parameter": "data[].data_source.source",6353 "type": "EvalJsonlFileContentSource | EvalJsonlFileIdSource | EvalResponsesSource",6354 "required": true,6355 "description": "Determines what populates the `item` namespace in this run's data source."6356 },6357 {6358 "parameter": "data[].metadata",6359 "type": "object | null",6360 "required": true,6361 "description": ""6362 },6363 {6364 "parameter": "data[].error",6365 "type": "object",6366 "required": true,6367 "description": "An object representing an error response from the Eval API."6368 },6369 {6370 "parameter": "data[].error.code",6371 "type": "string",6372 "required": true,6373 "description": "The error code."6374 },6375 {6376 "parameter": "data[].error.message",6377 "type": "string",6378 "required": true,6379 "description": "The error message."6380 },6381 {6382 "parameter": "first_id",6383 "type": "string",6384 "required": true,6385 "description": "The identifier of the first eval run in the data array."6386 },6387 {6388 "parameter": "last_id",6389 "type": "string",6390 "required": true,6391 "description": "The identifier of the last eval run in the data array."6392 },6393 {6394 "parameter": "has_more",6395 "type": "boolean",6396 "required": true,6397 "description": "Indicates whether there are more evals available."6398 }6399 ],6400 "status": [6401 "DOCUMENTED",6402 "DEPRECATED"6403 ],6404 "verification": {6405 "method": "docs_only"6406 },6407 "sources": [6408 {6409 "url": "https://developers.openai.com/api/reference/resources/evals",6410 "retrieved_at": "2026-09-18"6411 },6412 {6413 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",6414 "retrieved_at": "2026-09-18"6415 }6416 ]6417 },6418 {6419 "provider": "openai",6420 "api_family": "evals",6421 "name": "EvalRunOutputItemList",6422 "spec_schema": "EvalRunOutputItemList",6423 "object_type": "list",6424 "description": "An object representing a list of output items for an evaluation run.",6425 "required": [6426 "object",6427 "data",6428 "first_id",6429 "last_id",6430 "has_more"6431 ],6432 "fields": [6433 {6434 "parameter": "object",6435 "type": "string",6436 "required": true,6437 "enum": [6438 "list"6439 ],6440 "default": "list",6441 "description": "The type of this object. It is always set to \"list\"."6442 },6443 {6444 "parameter": "data",6445 "type": "array<object>",6446 "required": true,6447 "description": "An array of eval run output item objects."6448 },6449 {6450 "parameter": "data[].object",6451 "type": "string",6452 "required": true,6453 "enum": [6454 "eval.run.output_item"6455 ],6456 "default": "eval.run.output_item",6457 "description": "The type of the object. Always \"eval.run.output_item\"."6458 },6459 {6460 "parameter": "data[].id",6461 "type": "string",6462 "required": true,6463 "description": "Unique identifier for the evaluation run output item."6464 },6465 {6466 "parameter": "data[].run_id",6467 "type": "string",6468 "required": true,6469 "description": "The identifier of the evaluation run associated with this output item."6470 },6471 {6472 "parameter": "data[].eval_id",6473 "type": "string",6474 "required": true,6475 "description": "The identifier of the evaluation group."6476 },6477 {6478 "parameter": "data[].created_at",6479 "type": "integer",6480 "required": true,6481 "description": "Unix timestamp (in seconds) when the evaluation run was created."6482 },6483 {6484 "parameter": "data[].status",6485 "type": "string",6486 "required": true,6487 "description": "The status of the evaluation run."6488 },6489 {6490 "parameter": "data[].datasource_item_id",6491 "type": "integer",6492 "required": true,6493 "description": "The identifier for the data source item."6494 },6495 {6496 "parameter": "data[].datasource_item",6497 "type": "object",6498 "required": true,6499 "description": "Details of the input data source item."6500 },6501 {6502 "parameter": "data[].results",6503 "type": "array<object>",6504 "required": true,6505 "description": "A list of grader results for this output item."6506 },6507 {6508 "parameter": "data[].results[].name",6509 "type": "string",6510 "required": true,6511 "description": "The name of the grader."6512 },6513 {6514 "parameter": "data[].results[].type",6515 "type": "string",6516 "description": "The grader type (for example, \"string-check-grader\")."6517 },6518 {6519 "parameter": "data[].results[].score",6520 "type": "number",6521 "required": true,6522 "description": "The numeric score produced by the grader."6523 },6524 {6525 "parameter": "data[].results[].passed",6526 "type": "boolean",6527 "required": true,6528 "description": "Whether the grader considered the output a pass."6529 },6530 {6531 "parameter": "data[].results[].sample",6532 "type": "object | null",6533 "description": "Optional sample or intermediate data produced by the grader."6534 },6535 {6536 "parameter": "data[].sample",6537 "type": "object",6538 "required": true,6539 "description": "A sample containing the input and output of the evaluation run."6540 },6541 {6542 "parameter": "data[].sample.input",6543 "type": "array<object>",6544 "required": true,6545 "description": "An array of input messages."6546 },6547 {6548 "parameter": "data[].sample.input[].role",6549 "type": "string",6550 "required": true,6551 "description": "The role of the message sender (e.g., system, user, developer)."6552 },6553 {6554 "parameter": "data[].sample.input[].content",6555 "type": "string",6556 "required": true,6557 "description": "The content of the message."6558 },6559 {6560 "parameter": "data[].sample.output",6561 "type": "array<object>",6562 "required": true,6563 "description": "An array of output messages."6564 },6565 {6566 "parameter": "data[].sample.output[].role",6567 "type": "string",6568 "description": "The role of the message (e.g. \"system\", \"assistant\", \"user\")."6569 },6570 {6571 "parameter": "data[].sample.output[].content",6572 "type": "string",6573 "description": "The content of the message."6574 },6575 {6576 "parameter": "data[].sample.finish_reason",6577 "type": "string",6578 "required": true,6579 "description": "The reason why the sample generation was finished."6580 },6581 {6582 "parameter": "data[].sample.model",6583 "type": "string",6584 "required": true,6585 "description": "The model used for generating the sample."6586 },6587 {6588 "parameter": "data[].sample.usage",6589 "type": "object",6590 "required": true,6591 "description": "Token usage details for the sample."6592 },6593 {6594 "parameter": "data[].sample.usage.total_tokens",6595 "type": "integer",6596 "required": true,6597 "description": "The total number of tokens used."6598 },6599 {6600 "parameter": "data[].sample.usage.completion_tokens",6601 "type": "integer",6602 "required": true,6603 "description": "The number of completion tokens generated."6604 },6605 {6606 "parameter": "data[].sample.usage.prompt_tokens",6607 "type": "integer",6608 "required": true,6609 "description": "The number of prompt tokens used."6610 },6611 {6612 "parameter": "data[].sample.usage.cached_tokens",6613 "type": "integer",6614 "required": true,6615 "description": "The number of tokens retrieved from cache."6616 },6617 {6618 "parameter": "data[].sample.error",6619 "type": "object",6620 "required": true,6621 "description": "An object representing an error response from the Eval API."6622 },6623 {6624 "parameter": "data[].sample.error.code",6625 "type": "string",6626 "required": true,6627 "description": "The error code."6628 },6629 {6630 "parameter": "data[].sample.error.message",6631 "type": "string",6632 "required": true,6633 "description": "The error message."6634 },6635 {6636 "parameter": "data[].sample.temperature",6637 "type": "number",6638 "required": true,6639 "description": "The sampling temperature used."6640 },6641 {6642 "parameter": "data[].sample.max_completion_tokens",6643 "type": "integer",6644 "required": true,6645 "description": "The maximum number of tokens allowed for completion."6646 },6647 {6648 "parameter": "data[].sample.top_p",6649 "type": "number",6650 "required": true,6651 "description": "The top_p value used for sampling."6652 },6653 {6654 "parameter": "data[].sample.seed",6655 "type": "integer",6656 "required": true,6657 "description": "The seed used for generating the sample."6658 },6659 {6660 "parameter": "first_id",6661 "type": "string",6662 "required": true,6663 "description": "The identifier of the first eval run output item in the data array."6664 },6665 {6666 "parameter": "last_id",6667 "type": "string",6668 "required": true,6669 "description": "The identifier of the last eval run output item in the data array."6670 },6671 {6672 "parameter": "has_more",6673 "type": "boolean",6674 "required": true,6675 "description": "Indicates whether there are more eval run output items available."6676 }6677 ],6678 "status": [6679 "DOCUMENTED",6680 "DEPRECATED"6681 ],6682 "verification": {6683 "method": "docs_only"6684 },6685 "sources": [6686 {6687 "url": "https://developers.openai.com/api/reference/resources/evals",6688 "retrieved_at": "2026-09-18"6689 },6690 {6691 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",6692 "retrieved_at": "2026-09-18"6693 }6694 ]6695 },6696 {6697 "provider": "openai",6698 "api_family": "vector_stores",6699 "name": "ComparisonFilter",6700 "spec_schema": "ComparisonFilter",6701 "object_type": null,6702 "description": "A filter used to compare a specified attribute key to a given value using a defined comparison operation.",6703 "required": [6704 "type",6705 "key",6706 "value"6707 ],6708 "fields": [6709 {6710 "parameter": "type",6711 "type": "string",6712 "required": true,6713 "enum": [6714 "eq",6715 "ne",6716 "gt",6717 "gte",6718 "lt",6719 "lte",6720 "in",6721 "nin"6722 ],6723 "default": "eq",6724 "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n- `eq`: equals\n- `ne`: not equal\n- `gt`: greater than\n- `gte`: greater than or equal\n- `lt`: less than\n- `lte`: less than or equal\n- `in`: in\n- `nin`: not in"6725 },6726 {6727 "parameter": "key",6728 "type": "string",6729 "required": true,6730 "description": "The key to compare against the value."6731 },6732 {6733 "parameter": "value",6734 "type": "string | number | boolean | array",6735 "required": true,6736 "description": "The value to compare against the attribute key; supports string, number, or boolean types."6737 }6738 ],6739 "status": [6740 "DOCUMENTED"6741 ],6742 "verification": {6743 "method": "docs_only"6744 },6745 "sources": [6746 {6747 "url": "https://developers.openai.com/api/reference/resources/vector_stores",6748 "retrieved_at": "2026-09-18"6749 },6750 {6751 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",6752 "retrieved_at": "2026-09-18"6753 }6754 ]6755 },6756 {6757 "provider": "openai",6758 "api_family": "vector_stores",6759 "name": "CompoundFilter",6760 "spec_schema": "CompoundFilter",6761 "object_type": null,6762 "description": "Combine multiple filters using `and` or `or`.",6763 "required": [6764 "type",6765 "filters"6766 ],6767 "fields": [6768 {6769 "parameter": "type",6770 "type": "string",6771 "required": true,6772 "enum": [6773 "and",6774 "or"6775 ],6776 "description": "Type of operation: `and` or `or`."6777 },6778 {6779 "parameter": "filters",6780 "type": "array<object>",6781 "required": true,6782 "description": "Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`."6783 },6784 {6785 "parameter": "filters[].type",6786 "type": "string",6787 "required": true,6788 "enum": [6789 "eq",6790 "ne",6791 "gt",6792 "gte",6793 "lt",6794 "lte",6795 "in",6796 "nin"6797 ],6798 "default": "eq",6799 "description": "Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.\n- `eq`: equals\n- `ne`: not equal\n- `gt`: greater than\n- `gte`: greater than or equal\n- `lt`: less than\n- `lte`: less than or equal\n- `in`: in\n- `nin`: not in"6800 },6801 {6802 "parameter": "filters[].key",6803 "type": "string",6804 "required": true,6805 "description": "The key to compare against the value."6806 },6807 {6808 "parameter": "filters[].value",6809 "type": "string | number | boolean | array",6810 "required": true,6811 "description": "The value to compare against the attribute key; supports string, number, or boolean types."6812 }6813 ],6814 "status": [6815 "DOCUMENTED"6816 ],6817 "verification": {6818 "method": "docs_only"6819 },6820 "sources": [6821 {6822 "url": "https://developers.openai.com/api/reference/resources/vector_stores",6823 "retrieved_at": "2026-09-18"6824 },6825 {6826 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",6827 "retrieved_at": "2026-09-18"6828 }6829 ]6830 },6831 {6832 "provider": "openai",6833 "api_family": "vector_stores",6834 "name": "StaticChunkingStrategy",6835 "spec_schema": "StaticChunkingStrategy",6836 "object_type": null,6837 "description": "",6838 "required": [6839 "max_chunk_size_tokens",6840 "chunk_overlap_tokens"6841 ],6842 "fields": [6843 {6844 "parameter": "max_chunk_size_tokens",6845 "type": "integer",6846 "required": true,6847 "minimum": 100,6848 "maximum": 4096,6849 "description": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`."6850 },6851 {6852 "parameter": "chunk_overlap_tokens",6853 "type": "integer",6854 "required": true,6855 "description": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`."6856 }6857 ],6858 "status": [6859 "DOCUMENTED"6860 ],6861 "verification": {6862 "method": "docs_only"6863 },6864 "sources": [6865 {6866 "url": "https://developers.openai.com/api/reference/resources/vector_stores",6867 "retrieved_at": "2026-09-18"6868 },6869 {6870 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",6871 "retrieved_at": "2026-09-18"6872 }6873 ]6874 },6875 {6876 "provider": "openai",6877 "api_family": "vector_stores",6878 "name": "VectorStoreExpirationAfter",6879 "spec_schema": "VectorStoreExpirationAfter",6880 "object_type": null,6881 "description": "The expiration policy for a vector store.",6882 "required": [6883 "anchor",6884 "days"6885 ],6886 "fields": [6887 {6888 "parameter": "anchor",6889 "type": "string",6890 "required": true,6891 "enum": [6892 "last_active_at"6893 ],6894 "description": "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`."6895 },6896 {6897 "parameter": "days",6898 "type": "integer",6899 "required": true,6900 "minimum": 1,6901 "maximum": 365,6902 "description": "The number of days after the anchor time that the vector store will expire."6903 }6904 ],6905 "status": [6906 "DOCUMENTED"6907 ],6908 "verification": {6909 "method": "docs_only"6910 },6911 "sources": [6912 {6913 "url": "https://developers.openai.com/api/reference/resources/vector_stores",6914 "retrieved_at": "2026-09-18"6915 },6916 {6917 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",6918 "retrieved_at": "2026-09-18"6919 }6920 ]6921 },6922 {6923 "provider": "openai",6924 "api_family": "files",6925 "name": "FileExpirationAfter",6926 "spec_schema": "FileExpirationAfter",6927 "object_type": null,6928 "description": "The expiration policy for a file. By default, files with `purpose=batch` expire after 30 days and all other files are persisted until they are manually deleted.",6929 "required": [6930 "anchor",6931 "seconds"6932 ],6933 "fields": [6934 {6935 "parameter": "anchor",6936 "type": "string",6937 "required": true,6938 "enum": [6939 "created_at"6940 ],6941 "description": "Anchor timestamp after which the expiration policy applies. Supported anchors: `created_at`."6942 },6943 {6944 "parameter": "seconds",6945 "type": "integer",6946 "required": true,6947 "minimum": 3600,6948 "maximum": 2592000,6949 "description": "The number of seconds after the anchor time that the file will expire. Must be between 3600 (1 hour) and 2592000 (30 days)."6950 }6951 ],6952 "status": [6953 "DOCUMENTED"6954 ],6955 "verification": {6956 "method": "docs_only"6957 },6958 "sources": [6959 {6960 "url": "https://developers.openai.com/api/reference/resources/files",6961 "retrieved_at": "2026-09-18"6962 },6963 {6964 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",6965 "retrieved_at": "2026-09-18"6966 }6967 ]6968 },6969 {6970 "provider": "openai",6971 "api_family": "batches",6972 "name": "BatchFileExpirationAfter",6973 "spec_schema": "BatchFileExpirationAfter",6974 "object_type": null,6975 "description": "The expiration policy for the output and/or error file that are generated for a batch.",6976 "required": [6977 "anchor",6978 "seconds"6979 ],6980 "fields": [6981 {6982 "parameter": "anchor",6983 "type": "string",6984 "required": true,6985 "enum": [6986 "created_at"6987 ],6988 "description": "Anchor timestamp after which the expiration policy applies. Supported anchors: `created_at`. Note that the anchor is the file creation time, not the time the batch is created."6989 },6990 {6991 "parameter": "seconds",6992 "type": "integer",6993 "required": true,6994 "minimum": 3600,6995 "maximum": 2592000,6996 "description": "The number of seconds after the anchor time that the file will expire. Must be between 3600 (1 hour) and 2592000 (30 days)."6997 }6998 ],6999 "status": [7000 "DOCUMENTED"7001 ],7002 "verification": {7003 "method": "docs_only"7004 },7005 "sources": [7006 {7007 "url": "https://developers.openai.com/api/reference/resources/batches",7008 "retrieved_at": "2026-09-18"7009 },7010 {7011 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",7012 "retrieved_at": "2026-09-18"7013 }7014 ]7015 },7016 {7017 "provider": "openai",7018 "api_family": "fine_tuning",7019 "name": "FineTuneMethod",7020 "spec_schema": "FineTuneMethod",7021 "object_type": null,7022 "description": "The method used for fine-tuning.",7023 "required": [7024 "type"7025 ],7026 "fields": [7027 {7028 "parameter": "type",7029 "type": "string",7030 "required": true,7031 "enum": [7032 "supervised",7033 "dpo",7034 "reinforcement"7035 ],7036 "description": "The type of method. Is either `supervised`, `dpo`, or `reinforcement`."7037 },7038 {7039 "parameter": "supervised",7040 "type": "object",7041 "description": "Configuration for the supervised fine-tuning method."7042 },7043 {7044 "parameter": "supervised.hyperparameters",7045 "type": "object",7046 "description": "The hyperparameters used for the fine-tuning job."7047 },7048 {7049 "parameter": "supervised.hyperparameters.batch_size",7050 "type": "string | integer",7051 "default": "auto",7052 "description": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance."7053 },7054 {7055 "parameter": "supervised.hyperparameters.learning_rate_multiplier",7056 "type": "string | number",7057 "default": "auto",7058 "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting."7059 },7060 {7061 "parameter": "supervised.hyperparameters.n_epochs",7062 "type": "string | integer",7063 "default": "auto",7064 "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset."7065 },7066 {7067 "parameter": "dpo",7068 "type": "object",7069 "description": "Configuration for the DPO fine-tuning method."7070 },7071 {7072 "parameter": "dpo.hyperparameters",7073 "type": "object",7074 "description": "The hyperparameters used for the DPO fine-tuning job."7075 },7076 {7077 "parameter": "dpo.hyperparameters.beta",7078 "type": "string | number",7079 "default": "auto",7080 "description": "The beta value for the DPO method. A higher beta value will increase the weight of the penalty between the policy and reference model."7081 },7082 {7083 "parameter": "dpo.hyperparameters.batch_size",7084 "type": "string | integer",7085 "default": "auto",7086 "description": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance."7087 },7088 {7089 "parameter": "dpo.hyperparameters.learning_rate_multiplier",7090 "type": "string | number",7091 "default": "auto",7092 "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting."7093 },7094 {7095 "parameter": "dpo.hyperparameters.n_epochs",7096 "type": "string | integer",7097 "default": "auto",7098 "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset."7099 },7100 {7101 "parameter": "reinforcement",7102 "type": "object",7103 "description": "Configuration for the reinforcement fine-tuning method."7104 },7105 {7106 "parameter": "reinforcement.grader",7107 "type": "object",7108 "required": true,7109 "description": "The grader used for the fine-tuning job."7110 },7111 {7112 "parameter": "reinforcement.grader.type",7113 "type": "string",7114 "required": true,7115 "enum": [7116 "string_check"7117 ],7118 "description": "The object type, which is always `string_check`."7119 },7120 {7121 "parameter": "reinforcement.grader.name",7122 "type": "string",7123 "required": true,7124 "description": "The name of the grader."7125 },7126 {7127 "parameter": "reinforcement.grader.input",7128 "type": "string",7129 "required": true,7130 "description": "The input text. This may include template strings."7131 },7132 {7133 "parameter": "reinforcement.grader.reference",7134 "type": "string",7135 "required": true,7136 "description": "The reference text. This may include template strings."7137 },7138 {7139 "parameter": "reinforcement.grader.operation",7140 "type": "string",7141 "required": true,7142 "enum": [7143 "eq",7144 "ne",7145 "like",7146 "ilike"7147 ],7148 "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`."7149 },7150 {7151 "parameter": "reinforcement.grader.type",7152 "type": "string",7153 "required": true,7154 "enum": [7155 "text_similarity"7156 ],7157 "default": "text_similarity",7158 "description": "The type of grader."7159 },7160 {7161 "parameter": "reinforcement.grader.name",7162 "type": "string",7163 "required": true,7164 "description": "The name of the grader."7165 },7166 {7167 "parameter": "reinforcement.grader.input",7168 "type": "string",7169 "required": true,7170 "description": "The text being graded."7171 },7172 {7173 "parameter": "reinforcement.grader.reference",7174 "type": "string",7175 "required": true,7176 "description": "The text being graded against."7177 },7178 {7179 "parameter": "reinforcement.grader.evaluation_metric",7180 "type": "string",7181 "required": true,7182 "enum": [7183 "cosine",7184 "fuzzy_match",7185 "bleu",7186 "gleu",7187 "meteor",7188 "rouge_1",7189 "rouge_2",7190 "rouge_3",7191 "rouge_4",7192 "rouge_5",7193 "rouge_l"7194 ],7195 "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`."7196 },7197 {7198 "parameter": "reinforcement.grader.type",7199 "type": "string",7200 "required": true,7201 "enum": [7202 "python"7203 ],7204 "description": "The object type, which is always `python`."7205 },7206 {7207 "parameter": "reinforcement.grader.name",7208 "type": "string",7209 "required": true,7210 "description": "The name of the grader."7211 },7212 {7213 "parameter": "reinforcement.grader.source",7214 "type": "string",7215 "required": true,7216 "description": "The source code of the python script."7217 },7218 {7219 "parameter": "reinforcement.grader.image_tag",7220 "type": "string",7221 "description": "The image tag to use for the python script."7222 },7223 {7224 "parameter": "reinforcement.grader.type",7225 "type": "string",7226 "required": true,7227 "enum": [7228 "score_model"7229 ],7230 "description": "The object type, which is always `score_model`."7231 },7232 {7233 "parameter": "reinforcement.grader.name",7234 "type": "string",7235 "required": true,7236 "description": "The name of the grader."7237 },7238 {7239 "parameter": "reinforcement.grader.model",7240 "type": "string",7241 "required": true,7242 "description": "The model to use for the evaluation."7243 },7244 {7245 "parameter": "reinforcement.grader.sampling_params",7246 "type": "object",7247 "description": "The sampling parameters for the model."7248 },7249 {7250 "parameter": "reinforcement.grader.sampling_params.seed",7251 "type": "integer | null",7252 "description": ""7253 },7254 {7255 "parameter": "reinforcement.grader.sampling_params.top_p",7256 "type": "number | null",7257 "description": ""7258 },7259 {7260 "parameter": "reinforcement.grader.sampling_params.temperature",7261 "type": "number | null",7262 "description": ""7263 },7264 {7265 "parameter": "reinforcement.grader.sampling_params.max_completions_tokens",7266 "type": "integer | null",7267 "description": ""7268 },7269 {7270 "parameter": "reinforcement.grader.sampling_params.reasoning_effort",7271 "type": "string | null",7272 "description": ""7273 },7274 {7275 "parameter": "reinforcement.grader.input",7276 "type": "array<object>",7277 "required": true,7278 "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings."7279 },7280 {7281 "parameter": "reinforcement.grader.input[].role",7282 "type": "string",7283 "required": true,7284 "enum": [7285 "user",7286 "assistant",7287 "system",7288 "developer"7289 ],7290 "description": "The role of the message input. One of `user`, `assistant`, `system`, or\n`developer`."7291 },7292 {7293 "parameter": "reinforcement.grader.input[].content",7294 "required": true,7295 "type": "object",7296 "description": ""7297 },7298 {7299 "parameter": "reinforcement.grader.input[].type",7300 "type": "string",7301 "enum": [7302 "message"7303 ],7304 "description": "The type of the message input. Always `message`."7305 },7306 {7307 "parameter": "reinforcement.grader.range",7308 "type": "array<number>",7309 "description": "The range of the score. Defaults to `[0, 1]`."7310 },7311 {7312 "parameter": "reinforcement.grader.type",7313 "type": "string",7314 "required": true,7315 "enum": [7316 "multi"7317 ],7318 "default": "multi",7319 "description": "The object type, which is always `multi`."7320 },7321 {7322 "parameter": "reinforcement.grader.name",7323 "type": "string",7324 "required": true,7325 "description": "The name of the grader."7326 },7327 {7328 "parameter": "reinforcement.grader.graders",7329 "type": "object | object | object | object | object",7330 "required": true,7331 "description": ""7332 },7333 {7334 "parameter": "reinforcement.grader.graders.type",7335 "type": "string",7336 "required": true,7337 "enum": [7338 "string_check"7339 ],7340 "description": "The object type, which is always `string_check`."7341 },7342 {7343 "parameter": "reinforcement.grader.graders.name",7344 "type": "string",7345 "required": true,7346 "description": "The name of the grader."7347 },7348 {7349 "parameter": "reinforcement.grader.graders.input",7350 "type": "string",7351 "required": true,7352 "description": "The input text. This may include template strings."7353 },7354 {7355 "parameter": "reinforcement.grader.graders.reference",7356 "type": "string",7357 "required": true,7358 "description": "The reference text. This may include template strings."7359 },7360 {7361 "parameter": "reinforcement.grader.graders.operation",7362 "type": "string",7363 "required": true,7364 "enum": [7365 "eq",7366 "ne",7367 "like",7368 "ilike"7369 ],7370 "description": "The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`."7371 },7372 {7373 "parameter": "reinforcement.grader.graders.type",7374 "type": "string",7375 "required": true,7376 "enum": [7377 "text_similarity"7378 ],7379 "default": "text_similarity",7380 "description": "The type of grader."7381 },7382 {7383 "parameter": "reinforcement.grader.graders.name",7384 "type": "string",7385 "required": true,7386 "description": "The name of the grader."7387 },7388 {7389 "parameter": "reinforcement.grader.graders.input",7390 "type": "string",7391 "required": true,7392 "description": "The text being graded."7393 },7394 {7395 "parameter": "reinforcement.grader.graders.reference",7396 "type": "string",7397 "required": true,7398 "description": "The text being graded against."7399 },7400 {7401 "parameter": "reinforcement.grader.graders.evaluation_metric",7402 "type": "string",7403 "required": true,7404 "enum": [7405 "cosine",7406 "fuzzy_match",7407 "bleu",7408 "gleu",7409 "meteor",7410 "rouge_1",7411 "rouge_2",7412 "rouge_3",7413 "rouge_4",7414 "rouge_5",7415 "rouge_l"7416 ],7417 "description": "The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, \n`gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, \nor `rouge_l`."7418 },7419 {7420 "parameter": "reinforcement.grader.graders.type",7421 "type": "string",7422 "required": true,7423 "enum": [7424 "python"7425 ],7426 "description": "The object type, which is always `python`."7427 },7428 {7429 "parameter": "reinforcement.grader.graders.name",7430 "type": "string",7431 "required": true,7432 "description": "The name of the grader."7433 },7434 {7435 "parameter": "reinforcement.grader.graders.source",7436 "type": "string",7437 "required": true,7438 "description": "The source code of the python script."7439 },7440 {7441 "parameter": "reinforcement.grader.graders.image_tag",7442 "type": "string",7443 "description": "The image tag to use for the python script."7444 },7445 {7446 "parameter": "reinforcement.grader.graders.type",7447 "type": "string",7448 "required": true,7449 "enum": [7450 "score_model"7451 ],7452 "description": "The object type, which is always `score_model`."7453 },7454 {7455 "parameter": "reinforcement.grader.graders.name",7456 "type": "string",7457 "required": true,7458 "description": "The name of the grader."7459 },7460 {7461 "parameter": "reinforcement.grader.graders.model",7462 "type": "string",7463 "required": true,7464 "description": "The model to use for the evaluation."7465 },7466 {7467 "parameter": "reinforcement.grader.graders.sampling_params",7468 "type": "object",7469 "description": "The sampling parameters for the model."7470 },7471 {7472 "parameter": "reinforcement.grader.graders.input",7473 "type": "array<EvalItem>",7474 "required": true,7475 "description": "The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings."7476 },7477 {7478 "parameter": "reinforcement.grader.graders.range",7479 "type": "array<number>",7480 "description": "The range of the score. Defaults to `[0, 1]`."7481 },7482 {7483 "parameter": "reinforcement.grader.graders.type",7484 "type": "string",7485 "required": true,7486 "enum": [7487 "label_model"7488 ],7489 "description": "The object type, which is always `label_model`."7490 },7491 {7492 "parameter": "reinforcement.grader.graders.name",7493 "type": "string",7494 "required": true,7495 "description": "The name of the grader."7496 },7497 {7498 "parameter": "reinforcement.grader.graders.model",7499 "type": "string",7500 "required": true,7501 "description": "The model to use for the evaluation. Must support structured outputs."7502 },7503 {7504 "parameter": "reinforcement.grader.graders.input",7505 "type": "array<EvalItem>",7506 "required": true,7507 "description": ""7508 },7509 {7510 "parameter": "reinforcement.grader.graders.labels",7511 "type": "array<string>",7512 "required": true,7513 "description": "The labels to assign to each item in the evaluation."7514 },7515 {7516 "parameter": "reinforcement.grader.graders.passing_labels",7517 "type": "array<string>",7518 "required": true,7519 "description": "The labels that indicate a passing result. Must be a subset of labels."7520 },7521 {7522 "parameter": "reinforcement.grader.calculate_output",7523 "type": "string",7524 "required": true,7525 "description": "A formula to calculate the output based on grader results."7526 },7527 {7528 "parameter": "reinforcement.hyperparameters",7529 "type": "object",7530 "description": "The hyperparameters used for the reinforcement fine-tuning job."7531 },7532 {7533 "parameter": "reinforcement.hyperparameters.batch_size",7534 "type": "string | integer",7535 "default": "auto",7536 "description": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance."7537 },7538 {7539 "parameter": "reinforcement.hyperparameters.learning_rate_multiplier",7540 "type": "string | number",7541 "default": "auto",7542 "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting."7543 },7544 {7545 "parameter": "reinforcement.hyperparameters.n_epochs",7546 "type": "string | integer",7547 "default": "auto",7548 "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset."7549 },7550 {7551 "parameter": "reinforcement.hyperparameters.reasoning_effort",7552 "type": "string",7553 "enum": [7554 "default",7555 "low",7556 "medium",7557 "high"7558 ],7559 "default": "default",7560 "description": "Level of reasoning effort."7561 },7562 {7563 "parameter": "reinforcement.hyperparameters.compute_multiplier",7564 "type": "string | number",7565 "default": "auto",7566 "description": "Multiplier on amount of compute used for exploring search space during training."7567 },7568 {7569 "parameter": "reinforcement.hyperparameters.eval_interval",7570 "type": "string | integer",7571 "default": "auto",7572 "description": "The number of training steps between evaluation runs."7573 },7574 {7575 "parameter": "reinforcement.hyperparameters.eval_samples",7576 "type": "string | integer",7577 "default": "auto",7578 "description": "Number of evaluation samples to generate per training step."7579 }7580 ],7581 "status": [7582 "DOCUMENTED",7583 "DEPRECATED"7584 ],7585 "verification": {7586 "method": "docs_only"7587 },7588 "sources": [7589 {7590 "url": "https://developers.openai.com/api/reference/resources/fine_tuning",7591 "retrieved_at": "2026-09-18"7592 },7593 {7594 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",7595 "retrieved_at": "2026-09-18"7596 }7597 ]7598 },7599 {7600 "provider": "openai",7601 "api_family": "fine_tuning",7602 "name": "FineTuneSupervisedHyperparameters",7603 "spec_schema": "FineTuneSupervisedHyperparameters",7604 "object_type": null,7605 "description": "The hyperparameters used for the fine-tuning job.",7606 "required": [],7607 "fields": [7608 {7609 "parameter": "batch_size",7610 "type": "string | integer",7611 "default": "auto",7612 "description": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance."7613 },7614 {7615 "parameter": "learning_rate_multiplier",7616 "type": "string | number",7617 "default": "auto",7618 "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting."7619 },7620 {7621 "parameter": "n_epochs",7622 "type": "string | integer",7623 "default": "auto",7624 "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset."7625 }7626 ],7627 "status": [7628 "DOCUMENTED",7629 "DEPRECATED"7630 ],7631 "verification": {7632 "method": "docs_only"7633 },7634 "sources": [7635 {7636 "url": "https://developers.openai.com/api/reference/resources/fine_tuning",7637 "retrieved_at": "2026-09-18"7638 },7639 {7640 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",7641 "retrieved_at": "2026-09-18"7642 }7643 ]7644 },7645 {7646 "provider": "openai",7647 "api_family": "fine_tuning",7648 "name": "FineTuneDPOHyperparameters",7649 "spec_schema": "FineTuneDPOHyperparameters",7650 "object_type": null,7651 "description": "The hyperparameters used for the DPO fine-tuning job.",7652 "required": [],7653 "fields": [7654 {7655 "parameter": "beta",7656 "type": "string | number",7657 "default": "auto",7658 "description": "The beta value for the DPO method. A higher beta value will increase the weight of the penalty between the policy and reference model."7659 },7660 {7661 "parameter": "batch_size",7662 "type": "string | integer",7663 "default": "auto",7664 "description": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance."7665 },7666 {7667 "parameter": "learning_rate_multiplier",7668 "type": "string | number",7669 "default": "auto",7670 "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting."7671 },7672 {7673 "parameter": "n_epochs",7674 "type": "string | integer",7675 "default": "auto",7676 "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset."7677 }7678 ],7679 "status": [7680 "DOCUMENTED",7681 "DEPRECATED"7682 ],7683 "verification": {7684 "method": "docs_only"7685 },7686 "sources": [7687 {7688 "url": "https://developers.openai.com/api/reference/resources/fine_tuning",7689 "retrieved_at": "2026-09-18"7690 },7691 {7692 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",7693 "retrieved_at": "2026-09-18"7694 }7695 ]7696 },7697 {7698 "provider": "openai",7699 "api_family": "fine_tuning",7700 "name": "FineTuneReinforcementHyperparameters",7701 "spec_schema": "FineTuneReinforcementHyperparameters",7702 "object_type": null,7703 "description": "The hyperparameters used for the reinforcement fine-tuning job.",7704 "required": [],7705 "fields": [7706 {7707 "parameter": "batch_size",7708 "type": "string | integer",7709 "default": "auto",7710 "description": "Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance."7711 },7712 {7713 "parameter": "learning_rate_multiplier",7714 "type": "string | number",7715 "default": "auto",7716 "description": "Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting."7717 },7718 {7719 "parameter": "n_epochs",7720 "type": "string | integer",7721 "default": "auto",7722 "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset."7723 },7724 {7725 "parameter": "reasoning_effort",7726 "type": "string",7727 "enum": [7728 "default",7729 "low",7730 "medium",7731 "high"7732 ],7733 "default": "default",7734 "description": "Level of reasoning effort."7735 },7736 {7737 "parameter": "compute_multiplier",7738 "type": "string | number",7739 "default": "auto",7740 "description": "Multiplier on amount of compute used for exploring search space during training."7741 },7742 {7743 "parameter": "eval_interval",7744 "type": "string | integer",7745 "default": "auto",7746 "description": "The number of training steps between evaluation runs."7747 },7748 {7749 "parameter": "eval_samples",7750 "type": "string | integer",7751 "default": "auto",7752 "description": "Number of evaluation samples to generate per training step."7753 }7754 ],7755 "status": [7756 "DOCUMENTED",7757 "DEPRECATED"7758 ],7759 "verification": {7760 "method": "docs_only"7761 },7762 "sources": [7763 {7764 "url": "https://developers.openai.com/api/reference/resources/fine_tuning",7765 "retrieved_at": "2026-09-18"7766 },7767 {7768 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",7769 "retrieved_at": "2026-09-18"7770 }7771 ]7772 },7773 {7774 "provider": "openai",7775 "api_family": "fine_tuning",7776 "name": "FineTuneChatCompletionRequestAssistantMessage",7777 "spec_schema": "FineTuneChatCompletionRequestAssistantMessage",7778 "object_type": null,7779 "description": "",7780 "required": [7781 "role"7782 ],7783 "fields": [7784 {7785 "parameter": "weight",7786 "type": "integer",7787 "enum": [7788 0,7789 17790 ],7791 "description": "Controls whether the assistant message is trained against (0 or 1)"7792 },7793 {7794 "parameter": "content",7795 "type": "object | null",7796 "description": ""7797 },7798 {7799 "parameter": "refusal",7800 "type": "string | null",7801 "description": ""7802 },7803 {7804 "parameter": "role",7805 "type": "string",7806 "required": true,7807 "enum": [7808 "assistant"7809 ],7810 "description": "The role of the messages author, in this case `assistant`."7811 },7812 {7813 "parameter": "name",7814 "type": "string",7815 "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role."7816 },7817 {7818 "parameter": "audio",7819 "type": "object | null",7820 "description": ""7821 },7822 {7823 "parameter": "audio.id",7824 "type": "string",7825 "required": true,7826 "description": "Unique identifier for a previous audio response from the model."7827 },7828 {7829 "parameter": "tool_calls",7830 "type": "array<object>",7831 "description": "The tool calls generated by the model, such as function calls."7832 },7833 {7834 "parameter": "tool_calls[].id",7835 "type": "string",7836 "required": true,7837 "description": "The ID of the tool call."7838 },7839 {7840 "parameter": "tool_calls[].type",7841 "type": "string",7842 "required": true,7843 "enum": [7844 "function"7845 ],7846 "description": "The type of the tool. Currently, only `function` is supported."7847 },7848 {7849 "parameter": "tool_calls[].function",7850 "type": "object",7851 "required": true,7852 "description": "The function that the model called."7853 },7854 {7855 "parameter": "tool_calls[].function.name",7856 "type": "string",7857 "required": true,7858 "description": "The name of the function to call."7859 },7860 {7861 "parameter": "tool_calls[].function.arguments",7862 "type": "string",7863 "required": true,7864 "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."7865 },7866 {7867 "parameter": "tool_calls[].id",7868 "type": "string",7869 "required": true,7870 "description": "The ID of the tool call."7871 },7872 {7873 "parameter": "tool_calls[].type",7874 "type": "string",7875 "required": true,7876 "enum": [7877 "custom"7878 ],7879 "description": "The type of the tool. Always `custom`."7880 },7881 {7882 "parameter": "tool_calls[].custom",7883 "type": "object",7884 "required": true,7885 "description": "The custom tool that the model called."7886 },7887 {7888 "parameter": "tool_calls[].custom.name",7889 "type": "string",7890 "required": true,7891 "description": "The name of the custom tool to call."7892 },7893 {7894 "parameter": "tool_calls[].custom.input",7895 "type": "string",7896 "required": true,7897 "description": "The input for the custom tool call generated by the model."7898 },7899 {7900 "parameter": "function_call",7901 "type": "object | null",7902 "description": ""7903 },7904 {7905 "parameter": "function_call.arguments",7906 "type": "string",7907 "required": true,7908 "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."7909 },7910 {7911 "parameter": "function_call.name",7912 "type": "string",7913 "required": true,7914 "description": "The name of the function to call."7915 }7916 ],7917 "status": [7918 "DOCUMENTED",7919 "DEPRECATED"7920 ],7921 "verification": {7922 "method": "docs_only"7923 },7924 "sources": [7925 {7926 "url": "https://developers.openai.com/api/reference/resources/fine_tuning",7927 "retrieved_at": "2026-09-18"7928 },7929 {7930 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",7931 "retrieved_at": "2026-09-18"7932 }7933 ]7934 },7935 {7936 "provider": "openai",7937 "api_family": "evals",7938 "name": "EvalCustomDataSourceConfig",7939 "spec_schema": "EvalCustomDataSourceConfig",7940 "object_type": null,7941 "description": "A CustomDataSourceConfig which specifies the schema of your `item` and optionally `sample` namespaces.\nThe response schema defines the shape of the data that will be:\n- Used to define your testing criteria and\n- What data is required when creating a run",7942 "required": [7943 "type",7944 "schema"7945 ],7946 "fields": [7947 {7948 "parameter": "type",7949 "type": "string",7950 "required": true,7951 "enum": [7952 "custom"7953 ],7954 "default": "custom",7955 "description": "The type of data source. Always `custom`."7956 },7957 {7958 "parameter": "schema",7959 "type": "object",7960 "required": true,7961 "description": "The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/)."7962 }7963 ],7964 "status": [7965 "DOCUMENTED",7966 "DEPRECATED"7967 ],7968 "verification": {7969 "method": "docs_only"7970 },7971 "sources": [7972 {7973 "url": "https://developers.openai.com/api/reference/resources/evals",7974 "retrieved_at": "2026-09-18"7975 },7976 {7977 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",7978 "retrieved_at": "2026-09-18"7979 }7980 ]7981 },7982 {7983 "provider": "openai",7984 "api_family": "evals",7985 "name": "EvalLogsDataSourceConfig",7986 "spec_schema": "EvalLogsDataSourceConfig",7987 "object_type": null,7988 "description": "A LogsDataSourceConfig which specifies the metadata property of your logs query.\nThis is usually metadata like `usecase=chatbot` or `prompt-version=v2`, etc.\nThe schema returned by this data source config is used to defined what variables are available in your evals.\n`item` and `sample` are both defined when using this data source config.",7989 "required": [7990 "type",7991 "schema"7992 ],7993 "fields": [7994 {7995 "parameter": "type",7996 "type": "string",7997 "required": true,7998 "enum": [7999 "logs"8000 ],8001 "default": "logs",8002 "description": "The type of data source. Always `logs`."8003 },8004 {8005 "parameter": "metadata",8006 "type": "object | null",8007 "description": ""8008 },8009 {8010 "parameter": "schema",8011 "type": "object",8012 "required": true,8013 "description": "The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/)."8014 }8015 ],8016 "status": [8017 "DOCUMENTED",8018 "DEPRECATED"8019 ],8020 "verification": {8021 "method": "docs_only"8022 },8023 "sources": [8024 {8025 "url": "https://developers.openai.com/api/reference/resources/evals",8026 "retrieved_at": "2026-09-18"8027 },8028 {8029 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",8030 "retrieved_at": "2026-09-18"8031 }8032 ]8033 },8034 {8035 "provider": "openai",8036 "api_family": "evals",8037 "name": "EvalStoredCompletionsDataSourceConfig",8038 "spec_schema": "EvalStoredCompletionsDataSourceConfig",8039 "object_type": null,8040 "description": "Deprecated in favor of LogsDataSourceConfig.",8041 "required": [8042 "type",8043 "schema"8044 ],8045 "fields": [8046 {8047 "parameter": "type",8048 "type": "string",8049 "required": true,8050 "enum": [8051 "stored_completions"8052 ],8053 "default": "stored_completions",8054 "description": "The type of data source. Always `stored_completions`."8055 },8056 {8057 "parameter": "metadata",8058 "type": "object | null",8059 "description": ""8060 },8061 {8062 "parameter": "schema",8063 "type": "object",8064 "required": true,8065 "description": "The json schema for the run data source items.\nLearn how to build JSON schemas [here](https://json-schema.org/)."8066 }8067 ],8068 "status": [8069 "DOCUMENTED",8070 "DEPRECATED"8071 ],8072 "verification": {8073 "method": "docs_only"8074 },8075 "sources": [8076 {8077 "url": "https://developers.openai.com/api/reference/resources/evals",8078 "retrieved_at": "2026-09-18"8079 },8080 {8081 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",8082 "retrieved_at": "2026-09-18"8083 }8084 ]8085 },8086 {8087 "provider": "openai",8088 "api_family": "evals",8089 "name": "EvalJsonlFileContentSource",8090 "spec_schema": "EvalJsonlFileContentSource",8091 "object_type": null,8092 "description": "",8093 "required": [8094 "type",8095 "content"8096 ],8097 "fields": [8098 {8099 "parameter": "type",8100 "type": "string",8101 "required": true,8102 "enum": [8103 "file_content"8104 ],8105 "default": "file_content",8106 "description": "The type of jsonl source. Always `file_content`."8107 },8108 {8109 "parameter": "content",8110 "type": "array<object>",8111 "required": true,8112 "description": "The content of the jsonl file."8113 },8114 {8115 "parameter": "content[].item",8116 "type": "object",8117 "required": true,8118 "description": ""8119 },8120 {8121 "parameter": "content[].sample",8122 "type": "object",8123 "description": ""8124 }8125 ],8126 "status": [8127 "DOCUMENTED",8128 "DEPRECATED"8129 ],8130 "verification": {8131 "method": "docs_only"8132 },8133 "sources": [8134 {8135 "url": "https://developers.openai.com/api/reference/resources/evals",8136 "retrieved_at": "2026-09-18"8137 },8138 {8139 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",8140 "retrieved_at": "2026-09-18"8141 }8142 ]8143 },8144 {8145 "provider": "openai",8146 "api_family": "evals",8147 "name": "EvalJsonlFileIdSource",8148 "spec_schema": "EvalJsonlFileIdSource",8149 "object_type": null,8150 "description": "",8151 "required": [8152 "type",8153 "id"8154 ],8155 "fields": [8156 {8157 "parameter": "type",8158 "type": "string",8159 "required": true,8160 "enum": [8161 "file_id"8162 ],8163 "default": "file_id",8164 "description": "The type of jsonl source. Always `file_id`."8165 },8166 {8167 "parameter": "id",8168 "type": "string",8169 "required": true,8170 "description": "The identifier of the file."8171 }8172 ],8173 "status": [8174 "DOCUMENTED",8175 "DEPRECATED"8176 ],8177 "verification": {8178 "method": "docs_only"8179 },8180 "sources": [8181 {8182 "url": "https://developers.openai.com/api/reference/resources/evals",8183 "retrieved_at": "2026-09-18"8184 },8185 {8186 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",8187 "retrieved_at": "2026-09-18"8188 }8189 ]8190 },8191 {8192 "provider": "openai",8193 "api_family": "evals",8194 "name": "EvalStoredCompletionsSource",8195 "spec_schema": "EvalStoredCompletionsSource",8196 "object_type": null,8197 "description": "A StoredCompletionsRunDataSource configuration describing a set of filters",8198 "required": [8199 "type"8200 ],8201 "fields": [8202 {8203 "parameter": "type",8204 "type": "string",8205 "required": true,8206 "enum": [8207 "stored_completions"8208 ],8209 "default": "stored_completions",8210 "description": "The type of source. Always `stored_completions`."8211 },8212 {8213 "parameter": "metadata",8214 "type": "object | null",8215 "description": ""8216 },8217 {8218 "parameter": "model",8219 "type": "string | null",8220 "description": ""8221 },8222 {8223 "parameter": "created_after",8224 "type": "integer | null",8225 "description": ""8226 },8227 {8228 "parameter": "created_before",8229 "type": "integer | null",8230 "description": ""8231 },8232 {8233 "parameter": "limit",8234 "type": "integer | null",8235 "description": ""8236 }8237 ],8238 "status": [8239 "DOCUMENTED",8240 "DEPRECATED"8241 ],8242 "verification": {8243 "method": "docs_only"8244 },8245 "sources": [8246 {8247 "url": "https://developers.openai.com/api/reference/resources/evals",8248 "retrieved_at": "2026-09-18"8249 },8250 {8251 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",8252 "retrieved_at": "2026-09-18"8253 }8254 ]8255 },8256 {8257 "provider": "openai",8258 "api_family": "evals",8259 "name": "EvalResponsesSource",8260 "spec_schema": "EvalResponsesSource",8261 "object_type": null,8262 "description": "A EvalResponsesSource object describing a run data source configuration.",8263 "required": [8264 "type"8265 ],8266 "fields": [8267 {8268 "parameter": "type",8269 "type": "string",8270 "required": true,8271 "enum": [8272 "responses"8273 ],8274 "description": "The type of run data source. Always `responses`."8275 },8276 {8277 "parameter": "metadata",8278 "type": "object | null",8279 "description": ""8280 },8281 {8282 "parameter": "model",8283 "type": "string | null",8284 "description": ""8285 },8286 {8287 "parameter": "instructions_search",8288 "type": "string | null",8289 "description": ""8290 },8291 {8292 "parameter": "created_after",8293 "type": "integer | null",8294 "description": ""8295 },8296 {8297 "parameter": "created_before",8298 "type": "integer | null",8299 "description": ""8300 },8301 {8302 "parameter": "reasoning_effort",8303 "type": "ReasoningEffort | null",8304 "description": ""8305 },8306 {8307 "parameter": "temperature",8308 "type": "number | null",8309 "description": ""8310 },8311 {8312 "parameter": "top_p",8313 "type": "number | null",8314 "description": ""8315 },8316 {8317 "parameter": "users",8318 "type": "array | null",8319 "description": ""8320 },8321 {8322 "parameter": "tools",8323 "type": "array | null",8324 "description": ""8325 }8326 ],8327 "status": [8328 "DOCUMENTED",8329 "DEPRECATED"8330 ],8331 "verification": {8332 "method": "docs_only"8333 },8334 "sources": [8335 {8336 "url": "https://developers.openai.com/api/reference/resources/evals",8337 "retrieved_at": "2026-09-18"8338 },8339 {8340 "url": "https://developers.openai.com/api/openapi (openapi-master.yaml)",8341 "retrieved_at": "2026-09-18"8342 }8343 ]8344 },8345 {8346 "provider": "openai",8347 "api_family": "batches",8348 "name": "BatchRequestInputLine",8349 "spec_schema": null,8350 "object_type": null,8351 "description": "One line of the batch input JSONL file.",8352 "required": [8353 "custom_id",8354 "method",8355 "url",8356 "body"8357 ],8358 "fields": [8359 {8360 "parameter": "custom_id",8361 "type": "string",8362 "required": true,8363 "description": "Unique id per line, echoed in output."8364 },8365 {8366 "parameter": "method",8367 "type": "string",8368 "required": true,8369 "enum": [8370 "POST"8371 ],8372 "description": "HTTP method."8373 },8374 {8375 "parameter": "url",8376 "type": "string",8377 "required": true,8378 "description": "Target endpoint path; must match batch.endpoint."8379 },8380 {8381 "parameter": "body",8382 "type": "object",8383 "required": true,8384 "description": "Request body of the target endpoint."8385 }8386 ],8387 "status": [8388 "DOCUMENTED"8389 ],8390 "verification": {8391 "method": "docs_only"8392 },8393 "sources": [8394 {8395 "url": "https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file",8396 "retrieved_at": "2026-09-18"8397 }8398 ]8399 },8400 {8401 "provider": "openai",8402 "api_family": "batches",8403 "name": "BatchRequestOutputLine",8404 "spec_schema": null,8405 "object_type": null,8406 "description": "One line of the batch output (output_file_id) or error (error_file_id) JSONL file. Exactly one of response/error is non-null.",8407 "required": [8408 "id",8409 "custom_id",8410 "response",8411 "error"8412 ],8413 "fields": [8414 {8415 "parameter": "id",8416 "type": "string",8417 "required": true,8418 "description": "batch_req_… id."8419 },8420 {8421 "parameter": "custom_id",8422 "type": "string",8423 "required": true,8424 "description": "Echo of the input custom_id."8425 },8426 {8427 "parameter": "response",8428 "type": "object | null",8429 "required": true,8430 "description": "{status_code, request_id, body} — body is the normal endpoint response."8431 },8432 {8433 "parameter": "response.status_code",8434 "type": "integer",8435 "required": true,8436 "description": "HTTP status of the individual request."8437 },8438 {8439 "parameter": "response.request_id",8440 "type": "string",8441 "required": true,8442 "description": "req_… id usable with support."8443 },8444 {8445 "parameter": "response.body",8446 "type": "object",8447 "required": true,8448 "description": "Endpoint response object (e.g. Response, ChatCompletion, embeddings list)."8449 },8450 {8451 "parameter": "error",8452 "type": "object | null",8453 "required": true,8454 "description": "{code, message}; e.g. code=batch_expired for requests cancelled at the 24h window."8455 }8456 ],8457 "status": [8458 "DOCUMENTED"8459 ],8460 "verification": {8461 "method": "docs_only"8462 },8463 "sources": [8464 {8465 "url": "https://developers.openai.com/api/docs/guides/batch#5-retrieve-the-results",8466 "retrieved_at": "2026-09-18"8467 }8468 ]8469 }8470]8471