Session

Generated from the Pydantic models in aind_behavior_services and used to generate the C# serializers via Bonsai.Sgen.

Download session.json

Full schema (expand to view)

{
  "properties": {
    "aind_behavior_services_pkg_version": {
      "default": "0.13.8",
      "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
      "title": "aind_behavior_services package version",
      "type": "string"
    },
    "version": {
      "const": "0.13.8",
      "default": "0.13.8",
      "title": "Version",
      "type": "string"
    },
    "experiment": {
      "default": null,
      "description": "Name of the experiment",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Experiment"
    },
    "experimenter": {
      "default": [],
      "description": "Name of the experimenter",
      "items": {
        "type": "string"
      },
      "title": "Experimenter",
      "type": "array"
    },
    "date": {
      "description": "Date of the experiment",
      "format": "date-time",
      "title": "Date",
      "type": "string"
    },
    "session_name": {
      "default": null,
      "description": "Name of the session. This will be used to create a folder in the root path. If not provided, it will be generated using subject and date.",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Session Name"
    },
    "subject": {
      "description": "Name of the subject",
      "title": "Subject",
      "type": "string"
    },
    "notes": {
      "default": null,
      "description": "Notes about the experiment",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Notes"
    },
    "commit_hash": {
      "default": null,
      "description": "Commit hash of the repository",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Commit Hash"
    },
    "allow_dirty_repo": {
      "default": false,
      "description": "Allow running from a dirty repository",
      "title": "Allow Dirty Repo",
      "type": "boolean"
    },
    "skip_hardware_validation": {
      "default": false,
      "description": "Skip hardware validation",
      "title": "Skip Hardware Validation",
      "type": "boolean"
    }
  },
  "required": [
    "subject"
  ],
  "title": "Session",
  "type": "object"
}