Microsoft Azure · Schema

Function tool call

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name Type Description
id string The ID of the tool call object.
type string The type of tool call. This is always going to be `function` for this type of tool call.
function object The definition of the function that was called.
View JSON Schema on GitHub

JSON Schema

microsoft-azure-runstepdetailstoolcallsfunctionobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/runStepDetailsToolCallsFunctionObject",
  "title": "Function tool call",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the tool call object."
    },
    "type": {
      "type": "string",
      "description": "The type of tool call. This is always going to be `function` for this type of tool call.",
      "enum": [
        "function"
      ],
      "x-ms-enum": {
        "name": "RunStepDetailsToolCallsFunctionObjectType",
        "modelAsString": true,
        "values": [
          {
            "value": "function"
          }
        ]
      }
    },
    "function": {
      "type": "object",
      "description": "The definition of the function that was called.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the function."
        },
        "arguments": {
          "type": "string",
          "description": "The arguments passed to the function."
        },
        "output": {
          "type": "string",
          "description": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.",
          "nullable": true
        }
      },
      "required": [
        "name",
        "arguments",
        "output"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "function"
  ]
}