Microsoft Azure · Schema

File citation

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "retrieval" tool to search files.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name Type Description
type string Always `file_citation`.
text string The text in the message content that needs to be replaced.
file_citation object
start_index integer
end_index integer
View JSON Schema on GitHub

JSON Schema

microsoft-azure-messagecontenttextannotationsfilecitationobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/messageContentTextAnnotationsFileCitationObject",
  "title": "File citation",
  "type": "object",
  "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"retrieval\" tool to search files.",
  "properties": {
    "type": {
      "description": "Always `file_citation`.",
      "type": "string",
      "enum": [
        "file_citation"
      ],
      "x-ms-enum": {
        "name": "FileCitationObjectType",
        "modelAsString": true,
        "values": [
          {
            "value": "file_citation",
            "description": "The file citation object type"
          }
        ]
      }
    },
    "text": {
      "description": "The text in the message content that needs to be replaced.",
      "type": "string"
    },
    "file_citation": {
      "type": "object",
      "properties": {
        "file_id": {
          "description": "The ID of the specific File the citation is from.",
          "type": "string"
        },
        "quote": {
          "description": "The specific quote in the file.",
          "type": "string"
        }
      },
      "required": [
        "file_id",
        "quote"
      ]
    },
    "start_index": {
      "type": "integer",
      "minimum": 0
    },
    "end_index": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "type",
    "text",
    "file_citation",
    "start_index",
    "end_index"
  ]
}