File path

A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name	Type	Description
type	string	Always `file_path`.
text	string	The text in the message content that needs to be replaced.
file_path	object
start_index	integer
end_index	integer

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/messageContentTextAnnotationsFilePathObject",
  "title": "File path",
  "type": "object",
  "description": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.",
  "properties": {
    "type": {
      "description": "Always `file_path`.",
      "type": "string",
      "enum": [
        "file_path"
      ],
      "x-ms-enum": {
        "name": "FilePathObjectType",
        "modelAsString": true,
        "values": [
          {
            "value": "file_path",
            "description": "The file path object type"
          }
        ]
      }
    },
    "text": {
      "description": "The text in the message content that needs to be replaced.",
      "type": "string"
    },
    "file_path": {
      "type": "object",
      "properties": {
        "file_id": {
          "description": "The ID of the file that was generated.",
          "type": "string"
        }
      },
      "required": [
        "file_id"
      ]
    },
    "start_index": {
      "type": "integer",
      "minimum": 0
    },
    "end_index": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "type",
    "text",
    "file_path",
    "start_index",
    "end_index"
  ]
}