AskResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/docsbot-ai/json-schema/docsbot-ai-ask-response-schema.json",
  "title": "AskResponse",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/docsbot-ai-openapi.json#/components/schemas/AskResponse",
  "properties": {
    "answer": {
      "type": "string",
      "title": "The answer to the question"
    },
    "couldAnswer": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Whether the question could be answered or not"
    },
    "sources": {
      "items": {
        "$ref": "#/$defs/Source"
      },
      "type": "array",
      "title": "The sources that were used to answer the question"
    },
    "history": {
      "items": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "type": "array",
      "title": "Chat history, comprised of Q/A pairs"
    },
    "id": {
      "type": "string",
      "title": "The id of the question/answer pair. Use this to rate the answer"
    }
  },
  "type": "object",
  "required": [
    "answer",
    "sources",
    "id"
  ],
  "$defs": {
    "Source": {
      "properties": {
        "type": {
          "type": "string",
          "title": "The type of the source, e.g. 'url' or 'document'"
        },
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "The title of the source"
        },
        "url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "The url of the source to link to"
        },
        "fileId": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "The file ID for fetching the full reconstructed document"
        },
        "page": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "title": "For PDFs, the page number of the source in the PDF"
        },
        "content": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "The raw text content of the source context, if full_source is True"
        },
        "used": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "title": "Whether the source was used in generating the response. Only present if classify is enabled"
        }
      },
      "type": "object",
      "required": [
        "type",
        "title",
        "url",
        "page"
      ],
      "title": "Source"
    }
  }
}