Microsoft Azure · Schema

ChatCompletionToolCall

A tool call generated by the model.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name Type Description
id string The ID of the tool call.
type string The type of the tool call.
function object The function that the model called.
View JSON Schema on GitHub

JSON Schema

microsoft-azure-chatcompletiontoolcall-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ChatCompletionToolCall",
  "title": "ChatCompletionToolCall",
  "type": "object",
  "description": "A tool call generated by the model.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the tool call.",
      "example": "abc123"
    },
    "type": {
      "type": "string",
      "enum": [
        "function"
      ],
      "description": "The type of the tool call.",
      "example": "function"
    },
    "function": {
      "type": "object",
      "description": "The function that the model called.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the function to call."
        },
        "arguments": {
          "type": "string",
          "description": "The arguments to call the function with, as generated by the model in JSON format."
        }
      },
      "required": [
        "name",
        "arguments"
      ],
      "example": "example_value"
    }
  },
  "required": [
    "id",
    "type",
    "function"
  ]
}