diff --git a/training/api-reference.mdx b/training/api-reference.mdx index 8d69462fd5..8ca19e39bc 100644 --- a/training/api-reference.mdx +++ b/training/api-reference.mdx @@ -33,6 +33,29 @@ https://api.training.wandb.ai/v1 ### models +- **[POST /v1/preview/models](https://docs.wandb.ai/training/api-reference/models/create-model-v1-preview-models)** - Create Model +- **[DELETE /v1/preview/models/{model_id}](https://docs.wandb.ai/training/api-reference/models/delete-model-v1-preview-models--model-id-)** - Delete Model +- **[DELETE /v1/preview/models/{model_id}/checkpoints](https://docs.wandb.ai/training/api-reference/models/delete-model-checkpoints-v1-preview-models--model-id--checkpoints)** - Delete Model Checkpoints +- **[GET /v1/preview/models/{model_id}/checkpoints](https://docs.wandb.ai/training/api-reference/models/list-model-checkpoints-v1-preview-models--model-id--checkpoints)** - List Model Checkpoints +- **[POST /v1/preview/models/{model_id}/log](https://docs.wandb.ai/training/api-reference/models/log-v1-preview-models--model-id--log)** - Log + +### training-jobs + +- **[POST /v1/preview/training-jobs](https://docs.wandb.ai/training/api-reference/training-jobs/create-training-job-v1-preview-training-jobs)** - Create Training Job +- **[GET /v1/preview/training-jobs/{training_job_id}](https://docs.wandb.ai/training/api-reference/training-jobs/get-training-job-v1-preview-training-jobs--training-job-id-)** - Get Training Job +- **[GET /v1/preview/training-jobs/{training_job_id}/events](https://docs.wandb.ai/training/api-reference/training-jobs/get-training-job-events-v1-preview-training-jobs--training-job-id--events)** - Get Training Job Events + +### Uncategorized + +- **[GET /v1/health](https://docs.wandb.ai/training/api-reference/uncategorized/health-check-v1-health)** - Health Check +- **[GET /v1/system-check](https://docs.wandb.ai/training/api-reference/uncategorized/system-check-v1-system-check)** - System Check +### chat-completions + +- **[POST /v1/chat/completions](https://docs.wandb.ai/training/api-reference/chat-completions/create-chat-completion-v1-chat-completions)** - Create Chat Completion +- **[POST /v1/chat/completions/](https://docs.wandb.ai/training/api-reference/chat-completions/create-chat-completion-v1-chat-completions-)** - Create Chat Completion + +### models + - **[POST /v1/preview/models](https://docs.wandb.ai/training/api-reference/models/create-model-v1-preview-models)** - Create Model - **[DELETE /v1/preview/models/{model_id}/checkpoints](https://docs.wandb.ai/training/api-reference/models/delete-model-checkpoints-v1-preview-models--model-id--checkpoints)** - Delete Model Checkpoints - **[GET /v1/preview/models/{model_id}/checkpoints](https://docs.wandb.ai/training/api-reference/models/list-model-checkpoints-v1-preview-models--model-id--checkpoints)** - List Model Checkpoints diff --git a/training/api-reference/openapi.json b/training/api-reference/openapi.json index 73a07e7963..30b8fc5598 100644 --- a/training/api-reference/openapi.json +++ b/training/api-reference/openapi.json @@ -290,6 +290,54 @@ } } }, + "/v1/preview/models/{model_id}": { + "delete": { + "tags": [ + "models" + ], + "summary": "Delete Model", + "description": "Delete a model, all its checkpoints, artifacts, and the associated W&B run.", + "operationId": "delete_model_v1_preview_models__model_id__delete", + "security": [ + { + "HTTPBearer": [] + } + ], + "parameters": [ + { + "name": "model_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Model Id" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteModelResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, "/v1/preview/models/{model_id}/log": { "post": { "tags": [ @@ -566,7 +614,8 @@ "type", "url_citation" ], - "title": "Annotation" + "title": "Annotation", + "description": "A URL citation when using web search." }, "AnnotationURLCitation": { "properties": { @@ -595,7 +644,8 @@ "title", "url" ], - "title": "AnnotationURLCitation" + "title": "AnnotationURLCitation", + "description": "A URL citation when using web search." }, "Audio": { "properties": { @@ -604,11 +654,13 @@ "title": "Id" } }, + "additionalProperties": true, "type": "object", "required": [ "id" ], - "title": "Audio" + "title": "Audio", + "description": "Data about a previous audio response from the model.\n[Learn more](https://platform.openai.com/docs/guides/audio)." }, "AudioURL": { "properties": { @@ -617,16 +669,35 @@ "title": "Url" } }, + "additionalProperties": true, "type": "object", "required": [ "url" ], "title": "AudioURL" }, - "BaseModel": { - "properties": {}, + "Author": { + "properties": { + "role": { + "$ref": "#/components/schemas/Role" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name" + } + }, "type": "object", - "title": "BaseModel" + "required": [ + "role" + ], + "title": "Author" }, "ChatCompletionAssistantMessageParam": { "properties": { @@ -672,7 +743,7 @@ "function_call": { "anyOf": [ { - "$ref": "#/components/schemas/openai__types__chat__chat_completion_assistant_message_param__FunctionCall" + "$ref": "#/components/schemas/FunctionCall-Input" }, { "type": "null" @@ -696,17 +767,26 @@ }, "tool_calls": { "items": { - "$ref": "#/components/schemas/ChatCompletionMessageToolCallParam" + "anyOf": [ + { + "$ref": "#/components/schemas/ChatCompletionMessageFunctionToolCallParam" + }, + { + "$ref": "#/components/schemas/ChatCompletionMessageCustomToolCallParam" + } + ] }, "type": "array", "title": "Tool Calls" } }, + "additionalProperties": true, "type": "object", "required": [ "role" ], - "title": "ChatCompletionAssistantMessageParam" + "title": "ChatCompletionAssistantMessageParam", + "description": "Messages sent by the model in response to user messages." }, "ChatCompletionAudio": { "properties": { @@ -735,7 +815,51 @@ "expires_at", "transcript" ], - "title": "ChatCompletionAudio" + "title": "ChatCompletionAudio", + "description": "If the audio output modality is requested, this object contains data\nabout the audio response from the model. [Learn more](https://platform.openai.com/docs/guides/audio)." + }, + "ChatCompletionContentPartAudioEmbedsParam": { + "properties": { + "audio_embeds": { + "anyOf": [ + { + "type": "string" + }, + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Audio Embeds" + }, + "type": { + "type": "string", + "const": "audio_embeds", + "title": "Type" + }, + "uuid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Uuid" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "type" + ], + "title": "ChatCompletionContentPartAudioEmbedsParam" }, "ChatCompletionContentPartAudioParam": { "properties": { @@ -748,6 +872,7 @@ "title": "Type" } }, + "additionalProperties": true, "type": "object", "required": [ "audio_url", @@ -767,6 +892,9 @@ "type": "string" }, "type": "object" + }, + { + "type": "null" } ], "title": "Image Embeds" @@ -775,11 +903,22 @@ "type": "string", "const": "image_embeds", "title": "Type" + }, + "uuid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Uuid" } }, + "additionalProperties": true, "type": "object", "required": [ - "image_embeds", "type" ], "title": "ChatCompletionContentPartImageEmbedsParam" @@ -795,12 +934,14 @@ "title": "Type" } }, + "additionalProperties": true, "type": "object", "required": [ "image_url", "type" ], - "title": "ChatCompletionContentPartImageParam" + "title": "ChatCompletionContentPartImageParam", + "description": "Learn about [image inputs](https://platform.openai.com/docs/guides/vision)." }, "ChatCompletionContentPartInputAudioParam": { "properties": { @@ -813,12 +954,14 @@ "title": "Type" } }, + "additionalProperties": true, "type": "object", "required": [ "input_audio", "type" ], - "title": "ChatCompletionContentPartInputAudioParam" + "title": "ChatCompletionContentPartInputAudioParam", + "description": "Learn about [audio inputs](https://platform.openai.com/docs/guides/audio)." }, "ChatCompletionContentPartRefusalParam": { "properties": { @@ -832,6 +975,7 @@ "title": "Type" } }, + "additionalProperties": true, "type": "object", "required": [ "refusal", @@ -851,12 +995,14 @@ "title": "Type" } }, + "additionalProperties": true, "type": "object", "required": [ "text", "type" ], - "title": "ChatCompletionContentPartTextParam" + "title": "ChatCompletionContentPartTextParam", + "description": "Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation)." }, "ChatCompletionContentPartVideoParam": { "properties": { @@ -869,6 +1015,7 @@ "title": "Type" } }, + "additionalProperties": true, "type": "object", "required": [ "video_url", @@ -902,12 +1049,14 @@ "title": "Name" } }, + "additionalProperties": true, "type": "object", "required": [ "content", "role" ], - "title": "ChatCompletionDeveloperMessageParam" + "title": "ChatCompletionDeveloperMessageParam", + "description": "Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, `developer` messages\nreplace the previous `system` messages." }, "ChatCompletionFunctionMessageParam": { "properties": { @@ -932,6 +1081,7 @@ "title": "Role" } }, + "additionalProperties": true, "type": "object", "required": [ "content", @@ -940,6 +1090,26 @@ ], "title": "ChatCompletionFunctionMessageParam" }, + "ChatCompletionFunctionToolParam": { + "properties": { + "function": { + "$ref": "#/components/schemas/openai__types__shared_params__function_definition__FunctionDefinition" + }, + "type": { + "type": "string", + "const": "function", + "title": "Type" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "function", + "type" + ], + "title": "ChatCompletionFunctionToolParam", + "description": "A function tool that can be used to generate a response." + }, "ChatCompletionLogProb": { "properties": { "token": { @@ -1090,7 +1260,7 @@ "function_call": { "anyOf": [ { - "$ref": "#/components/schemas/openai__types__chat__chat_completion_message__FunctionCall" + "$ref": "#/components/schemas/FunctionCall-Input" }, { "type": "null" @@ -1101,7 +1271,14 @@ "anyOf": [ { "items": { - "$ref": "#/components/schemas/ChatCompletionMessageToolCall" + "anyOf": [ + { + "$ref": "#/components/schemas/ChatCompletionMessageFunctionToolCall" + }, + { + "$ref": "#/components/schemas/ChatCompletionMessageCustomToolCall" + } + ] }, "type": "array" }, @@ -1117,16 +1294,67 @@ "required": [ "role" ], - "title": "ChatCompletionMessage" + "title": "ChatCompletionMessage", + "description": "A chat completion message generated by the model." + }, + "ChatCompletionMessageCustomToolCall": { + "properties": { + "id": { + "type": "string", + "title": "Id" + }, + "custom": { + "$ref": "#/components/schemas/Custom" + }, + "type": { + "type": "string", + "const": "custom", + "title": "Type" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "id", + "custom", + "type" + ], + "title": "ChatCompletionMessageCustomToolCall", + "description": "A call to a custom tool created by the model." + }, + "ChatCompletionMessageCustomToolCallParam": { + "properties": { + "id": { + "type": "string", + "title": "Id" + }, + "custom": { + "$ref": "#/components/schemas/Custom" + }, + "type": { + "type": "string", + "const": "custom", + "title": "Type" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "id", + "custom", + "type" + ], + "title": "ChatCompletionMessageCustomToolCallParam", + "description": "A call to a custom tool created by the model." }, - "ChatCompletionMessageToolCall": { + "ChatCompletionMessageFunctionToolCall": { "properties": { "id": { "type": "string", "title": "Id" }, "function": { - "$ref": "#/components/schemas/openai__types__chat__chat_completion_message_tool_call__Function" + "$ref": "#/components/schemas/Function" }, "type": { "type": "string", @@ -1141,16 +1369,17 @@ "function", "type" ], - "title": "ChatCompletionMessageToolCall" + "title": "ChatCompletionMessageFunctionToolCall", + "description": "A call to a function tool created by the model." }, - "ChatCompletionMessageToolCallParam": { + "ChatCompletionMessageFunctionToolCallParam": { "properties": { "id": { "type": "string", "title": "Id" }, "function": { - "$ref": "#/components/schemas/openai__types__chat__chat_completion_message_tool_call_param__Function" + "$ref": "#/components/schemas/Function" }, "type": { "type": "string", @@ -1158,13 +1387,15 @@ "title": "Type" } }, + "additionalProperties": true, "type": "object", "required": [ "id", "function", "type" ], - "title": "ChatCompletionMessageToolCallParam" + "title": "ChatCompletionMessageFunctionToolCallParam", + "description": "A call to a function tool created by the model." }, "ChatCompletionNamedFunction": { "properties": { @@ -1224,6 +1455,9 @@ }, { "$ref": "#/components/schemas/CustomChatCompletionMessageParam" + }, + { + "$ref": "#/components/schemas/Message" } ] }, @@ -1346,6 +1580,9 @@ { "$ref": "#/components/schemas/StructuralTagResponseFormat" }, + { + "$ref": "#/components/schemas/LegacyStructuralTagResponseFormat" + }, { "type": "null" } @@ -1465,39 +1702,49 @@ "title": "Tool Choice", "default": "none" }, - "parallel_tool_calls": { + "reasoning_effort": { "anyOf": [ { - "type": "boolean" + "type": "string", + "enum": [ + "low", + "medium", + "high" + ] }, { "type": "null" } ], - "title": "Parallel Tool Calls", - "default": false + "title": "Reasoning Effort" }, - "user": { + "include_reasoning": { + "type": "boolean", + "title": "Include Reasoning", + "default": true + }, + "parallel_tool_calls": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "User" + "title": "Parallel Tool Calls", + "default": true }, - "best_of": { + "user": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Best Of" + "title": "User" }, "use_beam_search": { "type": "boolean", @@ -1586,7 +1833,7 @@ "anyOf": [ { "type": "integer", - "minimum": 1.0 + "minimum": -1.0 }, { "type": "null" @@ -1706,144 +1953,73 @@ "title": "Mm Processor Kwargs", "description": "Additional kwargs to pass to the HF processor." }, - "guided_json": { + "structured_outputs": { "anyOf": [ { - "type": "string" - }, - { - "additionalProperties": true, - "type": "object" - }, - { - "$ref": "#/components/schemas/BaseModel" + "$ref": "#/components/schemas/StructuredOutputsParams" }, { "type": "null" } ], - "title": "Guided Json", - "description": "If specified, the output will follow the JSON schema." + "description": "Additional kwargs for structured outputs" + }, + "priority": { + "type": "integer", + "title": "Priority", + "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.", + "default": 0 + }, + "request_id": { + "type": "string", + "title": "Request Id", + "description": "The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response." }, - "guided_regex": { + "logits_processors": { "anyOf": [ { - "type": "string" + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/LogitsProcessorConstructor" + } + ] + }, + "type": "array" }, { "type": "null" } ], - "title": "Guided Regex", - "description": "If specified, the output will follow the regex pattern." + "title": "Logits Processors", + "description": "A list of either qualified names of logits processors, or constructor objects, to apply when sampling. A constructor is a JSON object with a required 'qualname' field specifying the qualified name of the processor class/factory, and optional 'args' and 'kwargs' fields containing positional and keyword arguments. For example: {'qualname': 'my_module.MyLogitsProcessor', 'args': [1, 2], 'kwargs': {'param': 'value'}}." }, - "guided_choice": { + "return_tokens_as_token_ids": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "type": "boolean" }, { "type": "null" } ], - "title": "Guided Choice", - "description": "If specified, the output will be exactly one of the choices." + "title": "Return Tokens As Token Ids", + "description": "If specified with 'logprobs', tokens are represented as strings of the form 'token_id:{token_id}' so that tokens that are not JSON-encodable can be identified." }, - "guided_grammar": { + "return_token_ids": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Guided Grammar", - "description": "If specified, the output will follow the context free grammar." - }, - "structural_tag": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Structural Tag", - "description": "If specified, the output will follow the structural tag schema." - }, - "guided_decoding_backend": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Guided Decoding Backend", - "description": "If specified, will override the default guided decoding backend of the server for this specific request. If set, must be either 'outlines' / 'lm-format-enforcer'" - }, - "guided_whitespace_pattern": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Guided Whitespace Pattern", - "description": "If specified, will override the default whitespace pattern for guided json decoding." - }, - "priority": { - "type": "integer", - "title": "Priority", - "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.", - "default": 0 - }, - "request_id": { - "type": "string", - "title": "Request Id", - "description": "The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response." - }, - "logits_processors": { - "anyOf": [ - { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/LogitsProcessorConstructor" - } - ] - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Logits Processors", - "description": "A list of either qualified names of logits processors, or constructor objects, to apply when sampling. A constructor is a JSON object with a required 'qualname' field specifying the qualified name of the processor class/factory, and optional 'args' and 'kwargs' fields containing positional and keyword arguments. For example: {'qualname': 'my_module.MyLogitsProcessor', 'args': [1, 2], 'kwargs': {'param': 'value'}}." - }, - "return_tokens_as_token_ids": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Return Tokens As Token Ids", - "description": "If specified with 'logprobs', tokens are represented as strings of the form 'token_id:{token_id}' so that tokens that are not JSON-encodable can be identified." + "title": "Return Token Ids", + "description": "If specified, the result will include token IDs alongside the generated text. In streaming mode, prompt_token_ids is included only in the first chunk, and token_ids contains the delta tokens for each chunk. This is useful for debugging or when you need to map generated text back to input tokens." }, "cache_salt": { "anyOf": [ @@ -1855,7 +2031,7 @@ } ], "title": "Cache Salt", - "description": "If specified, the prefix cache will be salted with the provided string to prevent an attacker to guess prompts in multi-user environments. The salt should be random, protected from access by 3rd parties, and long enough to be unpredictable (e.g., 43 characters base64-encoded, corresponding to 256 bit). Not supported by vLLM engine V0." + "description": "If specified, the prefix cache will be salted with the provided string to prevent an attacker to guess prompts in multi-user environments. The salt should be random, protected from access by 3rd parties, and long enough to be unpredictable (e.g., 43 characters base64-encoded, corresponding to 256 bit)." }, "kv_transfer_params": { "anyOf": [ @@ -1883,6 +2059,22 @@ }, { "type": "number" + }, + { + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + } + ] + }, + "type": "array" } ] }, @@ -1893,7 +2085,7 @@ } ], "title": "Vllm Xargs", - "description": "Additional request parameters with string or numeric values, used by custom extensions." + "description": "Additional request parameters with (list of) string or numeric values, used by custom extensions." } }, "additionalProperties": true, @@ -1986,6 +2178,20 @@ ], "title": "Prompt Logprobs" }, + "prompt_token_ids": { + "anyOf": [ + { + "items": { + "type": "integer" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Prompt Token Ids" + }, "kv_transfer_params": { "anyOf": [ { @@ -2053,6 +2259,20 @@ } ], "title": "Stop Reason" + }, + "token_ids": { + "anyOf": [ + { + "items": { + "type": "integer" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Token Ids" } }, "additionalProperties": true, @@ -2089,12 +2309,14 @@ "title": "Name" } }, + "additionalProperties": true, "type": "object", "required": [ "content", "role" ], - "title": "ChatCompletionSystemMessageParam" + "title": "ChatCompletionSystemMessageParam", + "description": "Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, use `developer` messages\nfor this purpose instead." }, "ChatCompletionTokenLogprob": { "properties": { @@ -2163,6 +2385,7 @@ "title": "Tool Call Id" } }, + "additionalProperties": true, "type": "object", "required": [ "content", @@ -2171,24 +2394,6 @@ ], "title": "ChatCompletionToolMessageParam" }, - "ChatCompletionToolParam": { - "properties": { - "function": { - "$ref": "#/components/schemas/openai__types__shared_params__function_definition__FunctionDefinition" - }, - "type": { - "type": "string", - "const": "function", - "title": "Type" - } - }, - "type": "object", - "required": [ - "function", - "type" - ], - "title": "ChatCompletionToolParam" - }, "ChatCompletionToolsParam": { "properties": { "type": { @@ -2198,7 +2403,7 @@ "default": "function" }, "function": { - "$ref": "#/components/schemas/vllm__entrypoints__openai__protocol__FunctionDefinition" + "$ref": "#/components/schemas/FunctionDefinition" } }, "additionalProperties": true, @@ -2247,12 +2452,14 @@ "title": "Name" } }, + "additionalProperties": true, "type": "object", "required": [ "content", "role" ], - "title": "ChatCompletionUserMessageParam" + "title": "ChatCompletionUserMessageParam", + "description": "Messages sent by an end user, containing prompts or additional context\ninformation." }, "ChatMessage": { "properties": { @@ -2319,6 +2526,17 @@ "type": "array", "title": "Tool Calls" }, + "reasoning": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Reasoning" + }, "reasoning_content": { "anyOf": [ { @@ -2439,7 +2657,13 @@ }, "additionalProperties": true, "type": "object", - "title": "ChoiceLogprobs" + "title": "ChoiceLogprobs", + "description": "Log probability information for the choice." + }, + "Content": { + "properties": {}, + "type": "object", + "title": "Content" }, "CreateTrainingJob": { "properties": { @@ -2474,45 +2698,102 @@ "title": "CreateTrainingJob", "description": "Schema for creating a new TrainingJob." }, - "CustomChatCompletionContentSimpleAudioParam": { + "Custom": { "properties": { - "audio_url": { + "input": { "type": "string", - "title": "Audio Url" + "title": "Input" + }, + "name": { + "type": "string", + "title": "Name" } }, + "additionalProperties": true, "type": "object", "required": [ - "audio_url" + "input", + "name" ], + "title": "Custom", + "description": "The custom tool that the model called." + }, + "CustomChatCompletionContentSimpleAudioParam": { + "properties": { + "audio_url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Audio Url" + } + }, + "additionalProperties": true, + "type": "object", "title": "CustomChatCompletionContentSimpleAudioParam", "description": "A simpler version of the param that only accepts a plain audio_url.\n\nExample:\n{\n \"audio_url\": \"https://example.com/audio.mp3\"\n}" }, "CustomChatCompletionContentSimpleImageParam": { "properties": { "image_url": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Image Url" + }, + "uuid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Uuid" } }, + "additionalProperties": true, "type": "object", - "required": [ - "image_url" - ], "title": "CustomChatCompletionContentSimpleImageParam", "description": "A simpler version of the param that only accepts a plain image_url.\nThis is supported by OpenAI API, although it is not documented.\n\nExample:\n{\n \"image_url\": \"https://example.com/image.jpg\"\n}" }, "CustomChatCompletionContentSimpleVideoParam": { "properties": { "video_url": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Video Url" + }, + "uuid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Uuid" } }, + "additionalProperties": true, "type": "object", - "required": [ - "video_url" - ], "title": "CustomChatCompletionContentSimpleVideoParam", "description": "A simpler version of the param that only accepts a plain audio_url.\n\nExample:\n{\n \"video_url\": \"https://example.com/video.mp4\"\n}" }, @@ -2557,6 +2838,9 @@ { "$ref": "#/components/schemas/ChatCompletionContentPartImageEmbedsParam" }, + { + "$ref": "#/components/schemas/ChatCompletionContentPartAudioEmbedsParam" + }, { "$ref": "#/components/schemas/CustomChatCompletionContentSimpleAudioParam" }, @@ -2595,7 +2879,7 @@ "anyOf": [ { "items": { - "$ref": "#/components/schemas/ChatCompletionMessageToolCallParam" + "$ref": "#/components/schemas/ChatCompletionMessageFunctionToolCallParam" }, "type": "array" }, @@ -2604,8 +2888,34 @@ } ], "title": "Tool Calls" + }, + "reasoning": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Reasoning" + }, + "tools": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/ChatCompletionFunctionToolParam" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Tools" } }, + "additionalProperties": true, "type": "object", "required": [ "role" @@ -2629,6 +2939,7 @@ "title": "Type" } }, + "additionalProperties": true, "type": "object", "required": [ "thinking", @@ -2676,9 +2987,34 @@ "title": "DeleteCheckpointsResponse", "description": "Schema for delete checkpoints response." }, + "DeleteModelResponse": { + "properties": { + "model_id": { + "type": "string", + "format": "uuid", + "title": "Model Id" + }, + "deleted_checkpoints": { + "type": "integer", + "title": "Deleted Checkpoints" + }, + "deleted_run": { + "type": "boolean", + "title": "Deleted Run" + } + }, + "type": "object", + "required": [ + "model_id", + "deleted_checkpoints", + "deleted_run" + ], + "title": "DeleteModelResponse", + "description": "Schema for delete model response." + }, "ExperimentalTrainingConfig": { "properties": { - "learning_rate": { + "advantage_balance": { "anyOf": [ { "type": "number" @@ -2687,27 +3023,132 @@ "type": "null" } ], - "title": "Learning Rate" + "title": "Advantage Balance" }, - "precalculate_logprobs": { + "epsilon": { "anyOf": [ { - "type": "boolean" + "type": "number" }, { "type": "null" } ], - "title": "Precalculate Logprobs" - } - }, - "type": "object", - "title": "ExperimentalTrainingConfig", - "description": "Schema for experimental training config." - }, - "File": { - "properties": { - "file": { + "title": "Epsilon" + }, + "epsilon_high": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Epsilon High" + }, + "importance_sampling_level": { + "anyOf": [ + { + "type": "string", + "enum": [ + "token", + "sequence", + "average", + "geometric_average" + ] + }, + { + "type": "null" + } + ], + "title": "Importance Sampling Level" + }, + "kimi_k2_tau": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Kimi K2 Tau" + }, + "learning_rate": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Learning Rate" + }, + "mask_prob_ratio": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Mask Prob Ratio" + }, + "max_negative_advantage_importance_sampling_weight": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Max Negative Advantage Importance Sampling Weight" + }, + "ppo": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Ppo" + }, + "precalculate_logprobs": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Precalculate Logprobs" + }, + "scale_rewards": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Scale Rewards" + } + }, + "type": "object", + "title": "ExperimentalTrainingConfig", + "description": "Schema for experimental training config." + }, + "File": { + "properties": { + "file": { "$ref": "#/components/schemas/FileFile" }, "type": { @@ -2716,12 +3157,14 @@ "title": "Type" } }, + "additionalProperties": true, "type": "object", "required": [ "file", "type" ], - "title": "File" + "title": "File", + "description": "Learn about [file inputs](https://platform.openai.com/docs/guides/text) for text generation." }, "FileFile": { "properties": { @@ -2738,9 +3181,50 @@ "title": "Filename" } }, + "additionalProperties": true, "type": "object", "title": "FileFile" }, + "Function": { + "properties": { + "arguments": { + "type": "string", + "title": "Arguments" + }, + "name": { + "type": "string", + "title": "Name" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "arguments", + "name" + ], + "title": "Function", + "description": "The function that the model called." + }, + "FunctionCall-Input": { + "properties": { + "arguments": { + "type": "string", + "title": "Arguments" + }, + "name": { + "type": "string", + "title": "Name" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "arguments", + "name" + ], + "title": "FunctionCall", + "description": "Deprecated and replaced by `tool_calls`.\n\nThe name and arguments of a function that should be called, as generated by the model." + }, "FunctionCall-Output": { "properties": { "name": { @@ -2760,6 +3244,43 @@ ], "title": "FunctionCall" }, + "FunctionDefinition": { + "properties": { + "name": { + "type": "string", + "title": "Name" + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" + }, + "parameters": { + "anyOf": [ + { + "additionalProperties": true, + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Parameters" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "name" + ], + "title": "FunctionDefinition" + }, "HTTPValidationError": { "properties": { "detail": { @@ -2808,7 +3329,7 @@ "anyOf": [ { "items": { - "$ref": "#/components/schemas/ChatCompletionToolParam" + "$ref": "#/components/schemas/ChatCompletionFunctionToolParam" }, "type": "array" }, @@ -2841,6 +3362,7 @@ "title": "Detail" } }, + "additionalProperties": true, "type": "object", "required": [ "url" @@ -2862,6 +3384,7 @@ "title": "Format" } }, + "additionalProperties": true, "type": "object", "required": [ "data", @@ -2917,6 +3440,68 @@ ], "title": "JsonSchemaResponseFormat" }, + "LegacyStructuralTag": { + "properties": { + "begin": { + "type": "string", + "title": "Begin" + }, + "schema": { + "anyOf": [ + { + "additionalProperties": true, + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Schema" + }, + "end": { + "type": "string", + "title": "End" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "begin", + "end" + ], + "title": "LegacyStructuralTag" + }, + "LegacyStructuralTagResponseFormat": { + "properties": { + "type": { + "type": "string", + "const": "structural_tag", + "title": "Type" + }, + "structures": { + "items": { + "$ref": "#/components/schemas/LegacyStructuralTag" + }, + "type": "array", + "title": "Structures" + }, + "triggers": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Triggers" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "type", + "structures", + "triggers" + ], + "title": "LegacyStructuralTagResponseFormat" + }, "LogRequest": { "properties": { "split": { @@ -3012,6 +3597,58 @@ ], "title": "Logprob" }, + "Message": { + "properties": { + "author": { + "$ref": "#/components/schemas/Author" + }, + "content": { + "items": { + "$ref": "#/components/schemas/Content" + }, + "type": "array", + "title": "Content" + }, + "channel": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Channel" + }, + "recipient": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Recipient" + }, + "content_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Content Type" + } + }, + "type": "object", + "required": [ + "author" + ], + "title": "Message" + }, "ModelCreate": { "properties": { "entity": { @@ -3233,6 +3870,18 @@ ], "title": "ResponseFormat" }, + "Role": { + "type": "string", + "enum": [ + "user", + "assistant", + "system", + "developer", + "tool" + ], + "title": "Role", + "description": "The role of a message author (mirrors ``chat::Role``)." + }, "StreamOptions": { "properties": { "include_usage": { @@ -3264,14 +3913,32 @@ "type": "object", "title": "StreamOptions" }, - "StructuralTag": { + "StructuralTagResponseFormat": { "properties": { - "begin": { + "type": { "type": "string", - "title": "Begin" + "const": "structural_tag", + "title": "Type" }, - "schema": { + "format": { + "title": "Format" + } + }, + "additionalProperties": true, + "type": "object", + "required": [ + "type", + "format" + ], + "title": "StructuralTagResponseFormat" + }, + "StructuredOutputsParams": { + "properties": { + "json": { "anyOf": [ + { + "type": "string" + }, { "additionalProperties": true, "type": "object" @@ -3280,51 +3947,111 @@ "type": "null" } ], - "title": "Schema" + "title": "Json" }, - "end": { - "type": "string", - "title": "End" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "begin", - "end" - ], - "title": "StructuralTag" - }, - "StructuralTagResponseFormat": { - "properties": { - "type": { - "type": "string", - "const": "structural_tag", - "title": "Type" + "regex": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Regex" }, - "structures": { - "items": { - "$ref": "#/components/schemas/StructuralTag" - }, - "type": "array", - "title": "Structures" + "choice": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Choice" }, - "triggers": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Triggers" + "grammar": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Grammar" + }, + "json_object": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Json Object" + }, + "disable_fallback": { + "type": "boolean", + "title": "Disable Fallback", + "default": false + }, + "disable_any_whitespace": { + "type": "boolean", + "title": "Disable Any Whitespace", + "default": false + }, + "disable_additional_properties": { + "type": "boolean", + "title": "Disable Additional Properties", + "default": false + }, + "whitespace_pattern": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Whitespace Pattern" + }, + "structural_tag": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Structural Tag" + }, + "_backend": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Backend" + }, + "_backend_was_auto": { + "type": "boolean", + "title": "Backend Was Auto", + "default": false } }, - "additionalProperties": true, "type": "object", - "required": [ - "type", - "structures", - "triggers" - ], - "title": "StructuralTagResponseFormat" + "title": "StructuredOutputsParams" }, "ToolCall": { "properties": { @@ -3468,7 +4195,7 @@ "anyOf": [ { "items": { - "$ref": "#/components/schemas/ChatCompletionToolParam" + "$ref": "#/components/schemas/ChatCompletionFunctionToolParam" }, "type": "array" }, @@ -3508,6 +4235,24 @@ "title": "Metrics", "default": {} }, + "auto_metrics": { + "additionalProperties": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "integer" + }, + { + "type": "boolean" + } + ] + }, + "type": "object", + "title": "Auto Metrics", + "default": {} + }, "metadata": { "additionalProperties": { "anyOf": [ @@ -3648,86 +4393,13 @@ "title": "Url" } }, + "additionalProperties": true, "type": "object", "required": [ "url" ], "title": "VideoURL" }, - "openai__types__chat__chat_completion_assistant_message_param__FunctionCall": { - "properties": { - "arguments": { - "type": "string", - "title": "Arguments" - }, - "name": { - "type": "string", - "title": "Name" - } - }, - "type": "object", - "required": [ - "arguments", - "name" - ], - "title": "FunctionCall" - }, - "openai__types__chat__chat_completion_message__FunctionCall": { - "properties": { - "arguments": { - "type": "string", - "title": "Arguments" - }, - "name": { - "type": "string", - "title": "Name" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "arguments", - "name" - ], - "title": "FunctionCall" - }, - "openai__types__chat__chat_completion_message_tool_call__Function": { - "properties": { - "arguments": { - "type": "string", - "title": "Arguments" - }, - "name": { - "type": "string", - "title": "Name" - } - }, - "additionalProperties": true, - "type": "object", - "required": [ - "arguments", - "name" - ], - "title": "Function" - }, - "openai__types__chat__chat_completion_message_tool_call_param__Function": { - "properties": { - "arguments": { - "type": "string", - "title": "Arguments" - }, - "name": { - "type": "string", - "title": "Name" - } - }, - "type": "object", - "required": [ - "arguments", - "name" - ], - "title": "Function" - }, "openai__types__shared_params__function_definition__FunctionDefinition": { "properties": { "name": { @@ -3755,42 +4427,6 @@ "title": "Strict" } }, - "type": "object", - "required": [ - "name" - ], - "title": "FunctionDefinition" - }, - "vllm__entrypoints__openai__protocol__FunctionDefinition": { - "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" - }, - "parameters": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Parameters" - } - }, "additionalProperties": true, "type": "object", "required": [