{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/compoid-com/json-schema/compoid-com-chat-completion-request-schema.json", "title": "ChatCompletionRequest", "x-generated": "2026-11-04", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/compoid-com-openapi.yml#/components/schemas/ChatCompletionRequest", "properties": { "messages": { "items": { "anyOf": [ { "$ref": "#/$defs/ChatCompletionDeveloperMessageParam" }, { "$ref": "#/$defs/ChatCompletionSystemMessageParam" }, { "$ref": "#/$defs/ChatCompletionUserMessageParam" }, { "$ref": "#/$defs/ChatCompletionAssistantMessageParam" }, { "$ref": "#/$defs/ChatCompletionToolMessageParam" }, { "$ref": "#/$defs/ChatCompletionFunctionMessageParam" }, { "$ref": "#/$defs/CustomChatCompletionMessageParam" }, { "$ref": "#/$defs/openai_harmony__Message" } ] }, "type": "array", "title": "Messages" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "frequency_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Frequency Penalty" }, "logit_bias": { "anyOf": [ { "additionalProperties": { "type": "number" }, "type": "object" }, { "type": "null" } ], "title": "Logit Bias" }, "logprobs": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Logprobs", "default": false }, "top_logprobs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Top Logprobs", "default": 0 }, "max_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Tokens", "deprecated": true }, "max_completion_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Completion Tokens" }, "n": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "N", "default": 1 }, "presence_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Presence Penalty" }, "response_format": { "anyOf": [ { "$ref": "#/$defs/ResponseFormat" }, { "$ref": "#/$defs/StructuralTagResponseFormat" }, { "$ref": "#/$defs/LegacyStructuralTagResponseFormat" }, { "type": "null" } ], "title": "Response Format" }, "seed": { "anyOf": [ { "type": "integer", "maximum": 9.223372036854776e+18, "minimum": -9.223372036854776e+18 }, { "type": "null" } ], "title": "Seed" }, "stop": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array", "maxItems": 4 }, { "type": "null" } ], "title": "Stop", "default": [] }, "stream": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Stream", "default": false }, "stream_options": { "anyOf": [ { "$ref": "#/$defs/StreamOptions" }, { "type": "null" } ] }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Temperature" }, "top_p": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Top P" }, "tools": { "anyOf": [ { "items": { "$ref": "#/$defs/ChatCompletionToolsParam" }, "type": "array" }, { "type": "null" } ], "title": "Tools" }, "tool_choice": { "anyOf": [ { "type": "string", "const": "none" }, { "type": "string", "const": "auto" }, { "type": "string", "const": "required" }, { "$ref": "#/$defs/ChatCompletionNamedToolChoiceParam" }, { "type": "null" } ], "title": "Tool Choice", "default": "none" }, "reasoning_effort": { "anyOf": [ { "type": "string", "enum": [ "none", "minimal", "low", "medium", "high", "xhigh", "max" ] }, { "type": "null" } ], "title": "Reasoning Effort", "description": "Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, xhigh, and max. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Note that 'max' is specific to the DeepSeek V4 series and is not part of the standard OpenAI API specification." }, "thinking_token_budget": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Thinking Token Budget" }, "include_reasoning": { "type": "boolean", "title": "Include Reasoning", "default": true }, "parallel_tool_calls": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Parallel Tool Calls", "default": true }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User" }, "use_beam_search": { "type": "boolean", "title": "Use Beam Search", "default": false }, "top_k": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Top K" }, "min_p": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Min P" }, "repetition_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Repetition Penalty" }, "watermarking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Watermarking" }, "length_penalty": { "type": "number", "title": "Length Penalty", "default": 1.0 }, "stop_token_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Stop Token Ids", "default": [] }, "include_stop_str_in_output": { "type": "boolean", "title": "Include Stop Str In Output", "default": false }, "ignore_eos": { "type": "boolean", "title": "Ignore Eos", "default": false }, "min_tokens": { "type": "integer", "title": "Min Tokens", "default": 0 }, "skip_special_tokens": { "type": "boolean", "title": "Skip Special Tokens", "default": true }, "spaces_between_special_tokens": { "type": "boolean", "title": "Spaces Between Special Tokens", "default": true }, "truncate_prompt_tokens": { "anyOf": [ { "type": "integer", "maximum": 9.223372036854776e+18, "minimum": -1.0 }, { "type": "null" } ], "title": "Truncate Prompt Tokens" }, "truncation_side": { "anyOf": [ { "type": "string", "enum": [ "left", "right" ] }, { "type": "null" } ], "title": "Truncation Side", "description": "Which side to truncate from when truncate_prompt_tokens is active. 'right' keeps the first N tokens. 'left' keeps the last N tokens." }, "prompt_logprobs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Prompt Logprobs" }, "logprob_token_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Logprob Token Ids", "description": "Specific vocab token IDs to return logprobs for at each generated position, in addition to the sampled token. More efficient than `top_logprobs=-1` when only a small fixed label set is needed (e.g. multilabel scoring where each label corresponds to a known vocab id). When set, this explicit token selection takes precedence over the natural top-k selected by `top_logprobs`. Requires `logprobs=True`." }, "allowed_token_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Allowed Token Ids" }, "bad_words": { "items": { "type": "string" }, "type": "array", "title": "Bad Words" }, "echo": { "type": "boolean", "title": "Echo", "description": "If true, the new message will be prepended with the last message if they belong to the same role.", "default": false }, "add_generation_prompt": { "type": "boolean", "title": "Add Generation Prompt", "description": "If true, the generation prompt will be added to the chat template. This is a parameter used by chat template in tokenizer config of the model.", "default": true }, "continue_final_message": { "type": "boolean", "title": "Continue Final Message", "description": "If this is set, the chat will be formatted so that the final message in the chat is open-ended, without any EOS tokens. The model will continue this message rather than starting a new one. This allows you to \"prefill\" part of the model's response for it. Cannot be used at the same time as `add_generation_prompt`.", "default": false }, "add_special_tokens": { "type": "boolean", "title": "Add Special Tokens", "description": "If true, special tokens (e.g. BOS) will be added to the prompt on top of what is added by the chat template. For most models, the chat template takes care of adding the special tokens so this should be set to false (as is the default).", "default": false }, "documents": { "anyOf": [ { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Documents", "description": "A list of dicts representing documents that will be accessible to the model if it is performing RAG (retrieval-augmented generation). If the template does not support RAG, this argument will have no effect. We recommend that each document should be a dict containing \"title\" and \"text\" keys." }, "chat_template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Chat Template", "description": "A Jinja template to use for this conversion. As of transformers v4.44, default chat template is no longer allowed, so you must provide a chat template if the tokenizer does not define one." }, "chat_template_kwargs": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Chat Template Kwargs", "description": "Additional keyword args to pass to the template renderer. Will be accessible by the chat template." }, "media_io_kwargs": { "anyOf": [ { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Media Io Kwargs", "description": "Additional kwargs to pass to the media IO connectors, keyed by modality. Merged with engine-level media_io_kwargs." }, "mm_processor_kwargs": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Mm Processor Kwargs", "description": "Additional kwargs to pass to the HF processor." }, "structured_outputs": { "anyOf": [ { "$ref": "#/$defs/StructuredOutputsParams" }, { "type": "null" } ], "description": "Additional kwargs for structured outputs" }, "priority": { "type": "integer", "maximum": 9.223372036854776e+18, "minimum": -9.223372036854776e+18, "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." }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id", "description": "Stable session identity shared by related requests. Unlike request_id, this value is expected to remain stable across multiple requests in the same conversation or agent session." }, "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." }, "return_token_ids": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "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." }, "routed_experts_prompt_start": { "type": "integer", "minimum": 0.0, "title": "Routed Experts Prompt Start", "description": "Skip the first N prompt tokens from returned routed-expert data.", "default": 0 }, "return_token_offsets": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Return Token Offsets", "description": "If true, return char-level (start, end) offsets for each token relative to the tokenized source string in the `token_offsets` field of the rendered response. Only supported on the `/v1/completions/render` and `/v1/chat/completions/render` endpoints; ignored on regular generation endpoints. Honored only for Fast (Rust-backed) tokenizers; otherwise `token_offsets` is null. For chat requests, offsets are relative to the templated prompt string (after applying the chat template). Multimodal inputs and pre-tokenized inputs always yield null.", "default": false }, "return_prompt_text": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Return Prompt Text", "description": "If true, the response will include ``prompt_text`` containing the prompt string produced by chat templating. In streaming mode it is sent only on the first chunk. This is useful for inspecting exactly what was fed into the model." }, "mm_payload": { "type": "string", "enum": [ "tensors", "none" ], "title": "Mm Payload", "description": "What the render response's `features` carry for multimodal items. 'tensors' serializes the processed tensors into `kwargs_data` and `mm_metadata`. 'none' sets both to null for callers that need only the token layout and item hashes, such as cache-aware routers. Do not send a 'none' response to `/inference/v1/generate` which reads a null `kwargs_data` as every item being cached. Only supported on the render endpoints. Ignored on regular generation endpoints.", "default": "tensors" }, "return_mm_kwargs": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Return Mm Kwargs", "description": "Deprecated alias: false is the same as `mm_payload='none'`. Ignored when `mm_payload` is set.", "deprecated": true }, "cache_salt": { "anyOf": [ { "type": "string", "maxLength": 1024, "minLength": 1 }, { "type": "null" } ], "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)." }, "kv_transfer_params": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Kv Transfer Params", "description": "KVTransfer parameters used for disaggregated serving." }, "ec_transfer_params": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ec Transfer Params", "description": "ECTransfer parameters used for encoder-cache disaggregated serving." }, "vllm_xargs": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ] }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "title": "Vllm Xargs", "description": "Additional request parameters with (list of) string or numeric values, used by custom extensions." }, "repetition_detection": { "anyOf": [ { "$ref": "#/$defs/RepetitionDetectionParams" }, { "type": "null" } ], "description": "Parameters for detecting repetitive N-gram patterns in output tokens. If such repetition is detected, generation will be ended early. LLMs can sometimes generate repetitive, unhelpful token patterns, stopping only when they hit the maximum output length (e.g. 'abcdabcdabcd...' or '\\emoji \\emoji \\emoji ...'). This feature can detect such behavior and terminate early, saving time and tokens." }, "stream_interval": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Stream Interval", "description": "Number of tokens to batch into each streamed chunk. Raises the server's `--stream-interval` for this request. Values below the server setting are clamped up to it. The first and last chunks are always sent immediately. Ignored for non-streaming requests." } }, "additionalProperties": true, "type": "object", "required": [ "messages" ], "$defs": { "Audio": { "properties": { "id": { "type": "string", "title": "Id" } }, "additionalProperties": true, "type": "object", "required": [ "id" ], "title": "Audio", "description": "Data about a previous audio response from the model.\n[Learn more](https://developers.openai.com/api/docs/guides/audio)." }, "AudioURL": { "properties": { "url": { "type": "string", "title": "Url" } }, "additionalProperties": true, "type": "object", "required": [ "url" ], "title": "AudioURL" }, "Author": { "properties": { "role": { "$ref": "#/$defs/Role" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "type": "object", "required": [ "role" ], "title": "Author" }, "ChatCompletionAssistantMessageParam": { "properties": { "role": { "type": "string", "const": "assistant", "title": "Role" }, "audio": { "anyOf": [ { "$ref": "#/$defs/Audio" }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "$ref": "#/$defs/ChatCompletionContentPartTextParam" }, { "$ref": "#/$defs/ChatCompletionContentPartRefusalParam" } ] }, "type": "array" }, { "type": "null" } ], "title": "Content" }, "function_call": { "anyOf": [ { "$ref": "#/$defs/FunctionCall" }, { "type": "null" } ] }, "name": { "type": "string", "title": "Name" }, "refusal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refusal" }, "tool_calls": { "items": { "anyOf": [ { "$ref": "#/$defs/ChatCompletionMessageFunctionToolCallParam" }, { "$ref": "#/$defs/ChatCompletionMessageCustomToolCallParam" } ] }, "type": "array", "title": "Tool Calls" } }, "additionalProperties": true, "type": "object", "required": [ "role" ], "title": "ChatCompletionAssistantMessageParam", "description": "Messages sent by the model in response to user messages." }, "ChatCompletionContentPartAudioEmbedsParam": { "properties": { "audio_embeds": { "anyOf": [ { "type": "string" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" } ] }, "type": "array" } ] }, "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": { "audio_url": { "$ref": "#/$defs/AudioURL" }, "type": { "type": "string", "const": "audio_url", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "audio_url", "type" ], "title": "ChatCompletionContentPartAudioParam" }, "ChatCompletionContentPartImageEmbedsParam": { "properties": { "image_embeds": { "anyOf": [ { "type": "string" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" } ] }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "title": "Image Embeds" }, "type": { "type": "string", "const": "image_embeds", "title": "Type" }, "uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uuid" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ChatCompletionContentPartImageEmbedsParam" }, "ChatCompletionContentPartImageParam": { "properties": { "image_url": { "$ref": "#/$defs/ImageURL" }, "type": { "type": "string", "const": "image_url", "title": "Type" }, "prompt_cache_breakpoint": { "$ref": "#/$defs/PromptCacheBreakpoint" } }, "additionalProperties": true, "type": "object", "required": [ "image_url", "type" ], "title": "ChatCompletionContentPartImageParam", "description": "Learn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision)." }, "ChatCompletionContentPartInputAudioParam": { "properties": { "input_audio": { "$ref": "#/$defs/InputAudio" }, "type": { "type": "string", "const": "input_audio", "title": "Type" }, "prompt_cache_breakpoint": { "$ref": "#/$defs/PromptCacheBreakpoint" } }, "additionalProperties": true, "type": "object", "required": [ "input_audio", "type" ], "title": "ChatCompletionContentPartInputAudioParam", "description": "Learn about [audio inputs](https://developers.openai.com/api/docs/guides/audio)." }, "ChatCompletionContentPartPromptEmbedsParam": { "properties": { "data": { "type": "string", "title": "Data" }, "type": { "type": "string", "const": "prompt_embeds", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "data", "type" ], "title": "ChatCompletionContentPartPromptEmbedsParam" }, "ChatCompletionContentPartRefusalParam": { "properties": { "refusal": { "type": "string", "title": "Refusal" }, "type": { "type": "string", "const": "refusal", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "refusal", "type" ], "title": "ChatCompletionContentPartRefusalParam" }, "ChatCompletionContentPartTextParam": { "properties": { "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "const": "text", "title": "Type" }, "prompt_cache_breakpoint": { "$ref": "#/$defs/PromptCacheBreakpoint" } }, "additionalProperties": true, "type": "object", "required": [ "text", "type" ], "title": "ChatCompletionContentPartTextParam", "description": "Learn about [text inputs](https://developers.openai.com/api/docs/guides/text)." }, "ChatCompletionContentPartVideoEmbedsParam": { "properties": { "video_embeds": { "anyOf": [ { "type": "string" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" } ] }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "title": "Video Embeds" }, "type": { "type": "string", "const": "video_embeds", "title": "Type" }, "uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uuid" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ChatCompletionContentPartVideoEmbedsParam" }, "ChatCompletionContentPartVideoParam": { "properties": { "video_url": { "$ref": "#/$defs/VideoURL" }, "type": { "type": "string", "const": "video_url", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "video_url", "type" ], "title": "ChatCompletionContentPartVideoParam" }, "ChatCompletionDeveloperMessageParam": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "$ref": "#/$defs/ChatCompletionContentPartTextParam" }, "type": "array" } ], "title": "Content" }, "role": { "type": "string", "const": "developer", "title": "Role" }, "name": { "type": "string", "title": "Name" } }, "additionalProperties": true, "type": "object", "required": [ "content", "role" ], "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": { "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "name": { "type": "string", "title": "Name" }, "role": { "type": "string", "const": "function", "title": "Role" } }, "additionalProperties": true, "type": "object", "required": [ "content", "name", "role" ], "title": "ChatCompletionFunctionMessageParam" }, "ChatCompletionFunctionToolParam": { "properties": { "function": { "$ref": "#/$defs/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." }, "ChatCompletionMessageCustomToolCallParam": { "properties": { "id": { "type": "string", "title": "Id" }, "custom": { "$ref": "#/$defs/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." }, "ChatCompletionMessageFunctionToolCallParam": { "properties": { "id": { "type": "string", "title": "Id" }, "function": { "$ref": "#/$defs/Function" }, "type": { "type": "string", "const": "function", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "id", "function", "type" ], "title": "ChatCompletionMessageFunctionToolCallParam", "description": "A call to a function tool created by the model." }, "ChatCompletionNamedFunction": { "properties": { "name": { "type": "string", "title": "Name" } }, "additionalProperties": true, "type": "object", "required": [ "name" ], "title": "ChatCompletionNamedFunction" }, "ChatCompletionNamedToolChoiceParam": { "properties": { "function": { "$ref": "#/$defs/ChatCompletionNamedFunction" }, "type": { "type": "string", "const": "function", "title": "Type", "default": "function" } }, "additionalProperties": true, "type": "object", "required": [ "function" ], "title": "ChatCompletionNamedToolChoiceParam" }, "ChatCompletionSystemMessageParam": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "$ref": "#/$defs/ChatCompletionContentPartTextParam" }, "type": "array" } ], "title": "Content" }, "role": { "type": "string", "const": "system", "title": "Role" }, "name": { "type": "string", "title": "Name" } }, "additionalProperties": true, "type": "object", "required": [ "content", "role" ], "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." }, "ChatCompletionToolMessageParam": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "$ref": "#/$defs/ChatCompletionContentPartTextParam" }, "type": "array" } ], "title": "Content" }, "role": { "type": "string", "const": "tool", "title": "Role" }, "tool_call_id": { "type": "string", "title": "Tool Call Id" } }, "additionalProperties": true, "type": "object", "required": [ "content", "role", "tool_call_id" ], "title": "ChatCompletionToolMessageParam" }, "ChatCompletionToolsParam": { "properties": { "type": { "type": "string", "const": "function", "title": "Type", "default": "function" }, "function": { "$ref": "#/$defs/vllm__entrypoints__generate__base__protocol__FunctionDefinition" }, "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Defer Loading" } }, "additionalProperties": true, "type": "object", "required": [ "function" ], "title": "ChatCompletionToolsParam" }, "ChatCompletionUserMessageParam": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "$ref": "#/$defs/ChatCompletionContentPartTextParam" }, { "$ref": "#/$defs/ChatCompletionContentPartImageParam" }, { "$ref": "#/$defs/ChatCompletionContentPartInputAudioParam" }, { "$ref": "#/$defs/File" } ] }, "type": "array" } ], "title": "Content" }, "role": { "type": "string", "const": "user", "title": "Role" }, "name": { "type": "string", "title": "Name" } }, "additionalProperties": true, "type": "object", "required": [ "content", "role" ], "title": "ChatCompletionUserMessageParam", "description": "Messages sent by an end user, containing prompts or additional context\ninformation." }, "Custom": { "properties": { "input": { "type": "string", "title": "Input" }, "name": { "type": "string", "title": "Name" } }, "additionalProperties": true, "type": "object", "required": [ "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": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" }, "uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uuid" } }, "additionalProperties": true, "type": "object", "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": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Url" }, "uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uuid" } }, "additionalProperties": true, "type": "object", "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}" }, "CustomChatCompletionContentToolReferenceParam": { "properties": { "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "const": "tool_reference", "title": "Type" } }, "additionalProperties": true, "type": "object", "title": "CustomChatCompletionContentToolReferenceParam", "description": "A tool reference content param that only accepts a plain tool name.\n\nExample:\n{\n \"name\": \"get_weather\",\n \"type\": \"tool_reference\"\n}" }, "CustomChatCompletionMessageParam": { "properties": { "role": { "type": "string", "title": "Role" }, "content": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "$ref": "#/$defs/ChatCompletionContentPartTextParam" }, { "$ref": "#/$defs/ChatCompletionContentPartImageParam" }, { "$ref": "#/$defs/ChatCompletionContentPartInputAudioParam" }, { "$ref": "#/$defs/File" }, { "$ref": "#/$defs/ChatCompletionContentPartAudioParam" }, { "$ref": "#/$defs/ChatCompletionContentPartVideoParam" }, { "$ref": "#/$defs/ChatCompletionContentPartRefusalParam" }, { "$ref": "#/$defs/CustomChatCompletionContentSimpleImageParam" }, { "$ref": "#/$defs/ChatCompletionContentPartImageEmbedsParam" }, { "$ref": "#/$defs/ChatCompletionContentPartAudioEmbedsParam" }, { "$ref": "#/$defs/ChatCompletionContentPartVideoEmbedsParam" }, { "$ref": "#/$defs/ChatCompletionContentPartPromptEmbedsParam" }, { "$ref": "#/$defs/CustomChatCompletionContentSimpleAudioParam" }, { "$ref": "#/$defs/CustomChatCompletionContentSimpleVideoParam" }, { "$ref": "#/$defs/CustomChatCompletionContentToolReferenceParam" }, { "type": "string" }, { "$ref": "#/$defs/CustomThinkCompletionContentParam" } ] }, "type": "array" } ], "title": "Content" }, "name": { "type": "string", "title": "Name" }, "tool_call_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tool Call Id" }, "tool_calls": { "anyOf": [ { "items": { "$ref": "#/$defs/ChatCompletionMessageFunctionToolCallParam" }, "type": "array" }, { "type": "null" } ], "title": "Tool Calls" }, "reasoning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reasoning" }, "tools": { "anyOf": [ { "items": { "$ref": "#/$defs/ChatCompletionFunctionToolParam" }, "type": "array" }, { "type": "null" } ], "title": "Tools" }, "task": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Task" } }, "additionalProperties": true, "type": "object", "required": [ "role" ], "title": "CustomChatCompletionMessageParam", "description": "Enables custom roles in the Chat Completion API." }, "CustomThinkCompletionContentParam": { "properties": { "thinking": { "type": "string", "title": "Thinking" }, "closed": { "type": "boolean", "title": "Closed" }, "type": { "type": "string", "const": "thinking", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "thinking", "type" ], "title": "CustomThinkCompletionContentParam", "description": "A Think Completion Content Param that accepts a plain text and a boolean.\n\nExample:\n{\n \"thinking\": \"I am thinking about the answer\",\n \"closed\": True,\n \"type\": \"thinking\"\n}" }, "File": { "properties": { "file": { "$ref": "#/$defs/FileFile" }, "type": { "type": "string", "const": "file", "title": "Type" }, "prompt_cache_breakpoint": { "$ref": "#/$defs/FilePromptCacheBreakpoint" } }, "additionalProperties": true, "type": "object", "required": [ "file", "type" ], "title": "File", "description": "Learn about [file inputs](https://developers.openai.com/api/docs/guides/text) for text generation." }, "FileFile": { "properties": { "file_data": { "type": "string", "title": "File Data" }, "file_id": { "type": "string", "title": "File Id" }, "filename": { "type": "string", "title": "Filename" } }, "additionalProperties": true, "type": "object", "title": "FileFile" }, "FilePromptCacheBreakpoint": { "properties": { "mode": { "type": "string", "const": "explicit", "title": "Mode" } }, "additionalProperties": true, "type": "object", "required": [ "mode" ], "title": "FilePromptCacheBreakpoint", "description": "Marks the exact end of a reusable prompt prefix.\n\nThe breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block." }, "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": { "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." }, "ImageURL": { "properties": { "url": { "type": "string", "title": "Url" }, "detail": { "type": "string", "enum": [ "auto", "low", "high", "original" ], "title": "Detail" } }, "additionalProperties": true, "type": "object", "required": [ "url" ], "title": "ImageURL" }, "InputAudio": { "properties": { "data": { "type": "string", "title": "Data" }, "format": { "type": "string", "enum": [ "wav", "mp3" ], "title": "Format" } }, "additionalProperties": true, "type": "object", "required": [ "data", "format" ], "title": "InputAudio" }, "JsonSchemaResponseFormat": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Schema" }, "strict": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Strict" } }, "additionalProperties": true, "type": "object", "required": [ "name" ], "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": "#/$defs/LegacyStructuralTag" }, "type": "array", "title": "Structures" }, "triggers": { "items": { "type": "string" }, "type": "array", "title": "Triggers" } }, "additionalProperties": true, "type": "object", "required": [ "type", "structures", "triggers" ], "title": "LegacyStructuralTagResponseFormat" }, "PromptCacheBreakpoint": { "properties": { "mode": { "type": "string", "const": "explicit", "title": "Mode" } }, "additionalProperties": true, "type": "object", "required": [ "mode" ], "title": "PromptCacheBreakpoint", "description": "Marks the exact end of a reusable prompt prefix.\n\nThe breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block." }, "RepetitionDetectionParams": { "properties": { "max_pattern_size": { "type": "integer", "title": "Max Pattern Size", "default": 0 }, "min_pattern_size": { "type": "integer", "title": "Min Pattern Size", "default": 0 }, "min_count": { "type": "integer", "title": "Min Count", "default": 0 } }, "type": "object", "title": "RepetitionDetectionParams", "description": "Parameters for detecting repetitive N-gram patterns in output tokens." }, "ResponseFormat": { "properties": { "type": { "type": "string", "enum": [ "text", "json_object", "json_schema" ], "title": "Type" }, "json_schema": { "anyOf": [ { "$ref": "#/$defs/JsonSchemaResponseFormat" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "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": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Include Usage", "default": false }, "continuous_usage_stats": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Continuous Usage Stats", "default": false } }, "additionalProperties": true, "type": "object", "title": "StreamOptions" }, "StructuralTagResponseFormat": { "properties": { "type": { "type": "string", "const": "structural_tag", "title": "Type" }, "format": { "title": "Format" } }, "additionalProperties": true, "type": "object", "required": [ "type", "format" ], "title": "StructuralTagResponseFormat" }, "StructuredOutputsParams": { "properties": { "json": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Json" }, "regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Regex" }, "choice": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Choice" }, "grammar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grammar" }, "json_object": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Json Object" }, "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 } }, "type": "object", "title": "StructuredOutputsParams" }, "VideoURL": { "properties": { "url": { "type": "string", "title": "Url" } }, "additionalProperties": true, "type": "object", "required": [ "url" ], "title": "VideoURL" }, "openai__types__shared_params__function_definition__FunctionDefinition": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "parameters": { "additionalProperties": true, "type": "object", "title": "Parameters" }, "strict": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Strict" } }, "additionalProperties": true, "type": "object", "required": [ "name" ], "title": "FunctionDefinition" }, "openai_harmony__Content": { "properties": {}, "type": "object", "title": "Content" }, "openai_harmony__Message": { "properties": { "author": { "$ref": "#/$defs/Author" }, "content": { "items": { "$ref": "#/$defs/openai_harmony__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" }, "vllm__entrypoints__generate__base__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" }, "strict": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Strict" }, "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Defer Loading" } }, "additionalProperties": true, "type": "object", "required": [ "name" ], "title": "FunctionDefinition" } } }