Microsoft Azure · Schema

runToolCallObject

Tool call objects

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name Type Description
id string The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint.
type string The type of tool call the output is required for. For now, this is always `function`.
function object The function definition.
View JSON Schema on GitHub

JSON Schema

microsoft-azure-runtoolcallobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/runToolCallObject",
  "title": "runToolCallObject",
  "type": "object",
  "description": "Tool call objects",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint."
    },
    "type": {
      "type": "string",
      "description": "The type of tool call the output is required for. For now, this is always `function`.",
      "enum": [
        "function"
      ],
      "x-ms-enum": {
        "name": "RunToolCallObjectType",
        "modelAsString": true,
        "values": [
          {
            "value": "function",
            "description": "The type of tool call the output is required for which is always `function` for now"
          },
          {
            "value": "rate_limit_exceeded",
            "description": "The server failed to respond to request due to rate limit exceeded"
          }
        ]
      }
    },
    "function": {
      "type": "object",
      "description": "The function definition.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the function."
        },
        "arguments": {
          "type": "string",
          "description": "The arguments that the model expects you to pass to the function."
        }
      },
      "required": [
        "name",
        "arguments"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "function"
  ]
}