Hugging Face · Example Payload

Hugging Face Chatcompletions Example

Hugging Face Chatcompletions Example is an example object payload from Hugging Face, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "chatCompletions",
  "method": "POST",
  "path": "/v1/chat/completions",
  "summary": "Create Chat Completion (openai Compatible)",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "ChatcompletionsRequestExample",
      "example": {
        "model": "example_value",
        "messages": [
          {
            "role": "system",
            "content": "example_value",
            "tool_calls": [
              {}
            ],
            "tool_call_id": "500123",
            "name": "Example Title"
          }
        ],
        "frequency_penalty": 42.5,
        "logprobs": true,
        "max_tokens": 10,
        "presence_penalty": 42.5,
        "response_format": "example_value",
        "seed": 10,
        "stop": [
          "example_value"
        ],
        "stream": true,
        "stream_options": {
          "include_usage": true
        },
        "temperature": 42.5,
        "tool_choice": "example_value",
        "tool_prompt": "example_value",
        "tools": [
          {
            "type": "example_value",
            "function": {
              "name": "Example Title",
              "description": "A sample description.",
              "parameters": "example_value"
            }
          }
        ],
        "top_logprobs": 10,
        "top_p": 42.5
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Chatcompletions200Example",
      "example": {
        "id": "abc123",
        "object": "example_value",
        "created": 10,
        "model": "example_value",
        "system_fingerprint": "example_value",
        "choices": [
          {
            "index": 10,
            "message": {
              "role": "example_value",
              "content": "example_value",
              "tool_calls": {},
              "tool_call_id": "500123"
            },
            "finish_reason": "stop",
            "logprobs": {
              "content": {}
            }
          }
        ],
        "usage": {
          "prompt_tokens": 10,
          "completion_tokens": 10,
          "total_tokens": 10
        }
      }
    },
    {
      "status": "200",
      "contentType": "text/event-stream",
      "name": "Chatcompletions200Example",
      "example": {
        "id": "abc123",
        "object": "example_value",
        "created": 10,
        "model": "example_value",
        "system_fingerprint": "example_value",
        "choices": [
          {
            "index": 10,
            "delta": {
              "role": "example_value",
              "content": "example_value",
              "tool_calls": {},
              "tool_call_id": "500123"
            },
            "finish_reason": "example_value",
            "logprobs": {
              "content": {}
            }
          }
        ],
        "usage": {
          "prompt_tokens": 10,
          "completion_tokens": 10,
          "total_tokens": 10
        }
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "Chatcompletions400Example",
      "example": {
        "error": "example_value",
        "error_type": "example_value"
      }
    },
    {
      "status": "422",
      "contentType": "application/json",
      "name": "Chatcompletions422Example",
      "example": {
        "error": "example_value",
        "error_type": "example_value"
      }
    },
    {
      "status": "429",
      "contentType": "application/json",
      "name": "Chatcompletions429Example",
      "example": {
        "error": "example_value",
        "error_type": "example_value"
      }
    }
  ]
}