Microsoft Azure · Example Payload

Microsoft Azure Chatcompletions Create Example

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Microsoft Azure Chatcompletions Create Example is an example object payload from Microsoft Azure, 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_Create",
  "method": "POST",
  "path": "/deployments/{deployment-id}/chat/completions",
  "summary": "Microsoft Azure Create a Chat Completion",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "ChatcompletionsCreateRequestExample",
      "example": {
        "messages": [
          {
            "role": "system",
            "content": "example_value",
            "name": "Example Title",
            "tool_calls": {},
            "tool_call_id": "500123"
          }
        ],
        "temperature": 42.5,
        "top_p": 42.5,
        "n": 10,
        "stream": true,
        "stop": "example_value",
        "max_tokens": 10,
        "presence_penalty": 42.5,
        "frequency_penalty": 42.5,
        "response_format": {
          "type": "text"
        },
        "seed": 10,
        "tools": [
          {
            "type": "function"
          }
        ],
        "tool_choice": "example_value",
        "user": "example_value"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "ChatcompletionsCreate200Example",
      "example": {
        "id": "abc123",
        "object": "chat.completion",
        "created": 10,
        "model": "example_value",
        "choices": [
          {
            "index": 10,
            "finish_reason": "stop"
          }
        ],
        "usage": {
          "prompt_tokens": 10,
          "completion_tokens": 10,
          "total_tokens": 10
        },
        "system_fingerprint": "example_value"
      }
    },
    {
      "status": "default",
      "contentType": "application/json",
      "name": "ChatcompletionsCreatedefaultExample",
      "example": {
        "error": {
          "code": "example_value",
          "message": "example_value",
          "param": "example_value",
          "type": "example_value",
          "inner_error": {
            "code": "example_value",
            "content_filter_result": "example_value"
          }
        }
      }
    }
  ]
}