Hugging Face · Schema

ChatCompletionRequest

Properties

Name Type Description
model string Model identifier (can be tgi or a model ID)
messages array Conversation messages
frequency_penalty number
logprobs boolean
max_tokens integer Maximum tokens to generate
presence_penalty number
response_format string
seed integer
stop array
stream boolean
stream_options object
temperature number
tool_choice string
tool_prompt string Prompt appended before tools
tools array
top_logprobs integer
top_p number
View JSON Schema on GitHub

JSON Schema

hugging-face-text-generation-inference-chat-completion-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ChatCompletionRequest",
  "type": "object",
  "properties": {
    "model": {
      "type": "string",
      "description": "Model identifier (can be tgi or a model ID)"
    },
    "messages": {
      "type": "array",
      "description": "Conversation messages"
    },
    "frequency_penalty": {
      "type": "number"
    },
    "logprobs": {
      "type": "boolean"
    },
    "max_tokens": {
      "type": "integer",
      "description": "Maximum tokens to generate"
    },
    "presence_penalty": {
      "type": "number"
    },
    "response_format": {
      "type": "string"
    },
    "seed": {
      "type": "integer"
    },
    "stop": {
      "type": "array"
    },
    "stream": {
      "type": "boolean"
    },
    "stream_options": {
      "type": "object"
    },
    "temperature": {
      "type": "number"
    },
    "tool_choice": {
      "type": "string"
    },
    "tool_prompt": {
      "type": "string",
      "description": "Prompt appended before tools"
    },
    "tools": {
      "type": "array"
    },
    "top_logprobs": {
      "type": "integer"
    },
    "top_p": {
      "type": "number"
    }
  }
}