json-schema

The following json-schemas are used as the format definition of the input for this task. They are the result of the Pydantic` models defined in src/aind_behavior_dynamic_foraging, and are also used to generate src/Extensions/AindBehaviorDynamicForaging.cs via Bonsai.Sgen.

Download Schema

Task Logic Schema

AindDynamicForagingTaskLogic

Main task logic model for the AIND Dynamic Foraging task. This is the top-level class that encapsulates the complete task logic specification for the dynamic foraging behavioral experiment. It includes all task parameters, environment specifications, and control settings.
type	object
properties
name	Name
	Name of the task logic
	type	string
	default	AindDynamicForaging
	const	AindDynamicForaging
description	Description
	Description of the task.
	type	string
	default
task_parameters	Parameters of the task logic
	#/$defs/AindDynamicForagingTaskParameters
version	Version
	type	string
	default	0.0.2-rc25
	const	0.0.2-rc25
stage_name	Stage Name
	Optional stage name the Task object instance represents.
	default	null
	oneOf	type	string
		type	null
additionalProperties	False

Rig Schema

AindDynamicForagingRig

type	object
properties
aind_behavior_services_pkg_version	aind_behavior_services package version
	type	string
	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-]+)*))?$
	default	0.13.5
version	Version
	type	string
	default	0.0.2-rc25
	const	0.0.2-rc25
computer_name	Computer Name
	Computer name
	type	string
rig_name	Rig Name
	Rig name
	type	string
data_directory	Data Directory
	Directory where data will be saved to
	type	string
	format	path
triggered_camera_controller	Required camera controller to triggered cameras.
	#/$defs/CameraController_SpinnakerCamera_
monitoring_camera_controller	Optional camera controller for monitoring cameras.
	default	null
	oneOf	#/$defs/CameraController_WebCamera_
		type	null
harp_behavior	Harp behavior
	#/$defs/HarpBehavior
harp_lickometer_left	Harp left lickometer
	default	null
	oneOf	#/$defs/HarpLicketySplit
		type	null
harp_lickometer_right	Harp right lickometer
	default	null
	oneOf	#/$defs/HarpLicketySplit
		type	null
harp_clock_generator	Harp clock generator
	#/$defs/HarpWhiteRabbit
harp_sound_card	Harp sound card
	#/$defs/DynamicForagingSoundCard
harp_sniff_detector	Harp sniff detector
	default	null
	oneOf	#/$defs/HarpSniffDetector
		type	null
harp_environment_sensor	Harp environment sensor
	default	null
	oneOf	#/$defs/HarpEnvironmentSensor
		type	null
manipulator	Manipulator
	#/$defs/AindManipulator
calibration	Calibration models
	#/$defs/RigCalibration