Microsoft Azure · Schema

chatCompletionMessageToolCall

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

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

JSON Schema

microsoft-azure-chatcompletionmessagetoolcall-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/chatCompletionMessageToolCall",
  "title": "chatCompletionMessageToolCall",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the tool call."
    },
    "type": {
      "$ref": "#/components/schemas/toolCallType"
    },
    "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. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."
        }
      },
      "required": [
        "name",
        "arguments"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "function"
  ]
}