Function reference
Architecture · Workflows · Setup
Named Python definitions and JavaScript function declarations. Arguments list names; source links preserve the containing module and its callbacks.
Routes
| Method | Path | Source |
|---|---|---|
| GET | /api/connections/custom/{connector_id}/execution |
execution |
| POST | /api/connections/custom/{connector_id}/execution/target |
target |
| POST | /api/connections/custom/{connector_id}/execution/activate |
activate |
| POST | /api/connections/custom/{connector_id}/execution/test |
test |
| POST | /api/connections/custom/{connector_id}/execution/revoke |
revoke |
| POST | /api/connections/custom/{connector_id}/execution/stop |
stop |
| GET | /api/files/{file_id}/page-preview |
metadata |
| POST | /api/files/{file_id}/preview |
prepare |
| GET | /api/files/{file_id}/pages/{page} |
page |
| GET | /api/harness |
harness |
| GET | /api/mcp/connections |
connections |
| POST | /api/mcp/connections |
create_connection |
| DELETE | /api/mcp/connections/{key} |
revoke_connection |
| GET | /api/agents/{agent_id}/phone |
phone_block |
| POST | /api/agents/{agent_id}/phone/participants |
phone_add |
| POST | /api/agents/{agent_id}/phone/participants/{member_id}/remove |
phone_remove |
| POST | /api/agents/{agent_id}/phone/participants/{member_id} |
phone_participant |
| POST | /api/agents/{agent_id}/phone/delivery |
phone_delivery_state |
| POST | /api/agents/{agent_id}/phone/contact-request |
phone_contact_request |
| GET | /api/profile-covers/{cover_id} |
cover |
| GET | /api/plugins/installed |
installed |
| POST | /api/plugins/{plugin_id}/install |
install |
| DELETE | /api/plugins/{plugin_id}/installation |
remove |
| GET | /api/organization/chats |
organization_chats |
| POST | /api/organization/chats |
organization_chat |
| GET | /api/messaging |
messaging_status |
| POST | /api/messaging/verification |
messaging_verification |
| POST | /api/messaging/verification/confirm |
messaging_confirm |
| POST | /api/messaging/hello |
messaging_hello |
| POST | /hooks/in/{environment}/{hook_id} |
incoming_hook |
| POST | /api/hooks/{environment}/{hook_id} |
incoming_hook |
| GET | /api/wakes |
wake_sources |
| POST | /api/wakes/endpoints/{endpoint_id}/secret |
endpoint_secret |
| POST | /api/wakes/hooks/{hook_id}/secret |
reveal_wake_secret |
| POST | /hooks/{channel}/{environment} |
messaging_webhook |
| GET | /hooks/{channel}/{environment} |
messaging_webhook |
| POST | /api/messaging/webhook/{environment}/{channel} |
messaging_webhook |
| GET | /api/plugins/catalogue |
plugins_catalogue |
| GET | /api/plugins/{plugin_id} |
plugin_details |
| GET | /api/connections |
connections |
| GET | /api/connections/custom |
custom_connections |
| POST | /api/connections/custom |
create_custom_connection |
| GET | /api/connections/custom/{connector_id} |
custom_connection |
| GET | /api/connections/custom/{connector_id}/package |
custom_connection_package |
| POST | /api/connections/custom/{connector_id}/secrets |
custom_connection_secret |
| DELETE | /api/connections/custom/{connector_id}/secrets/{name} |
custom_connection_secret_remove |
| POST | /api/connections/{provider}/connect |
connect_provider |
| GET | /api/connections/flows/{flow_id} |
connection_flow |
| DELETE | /api/connections/{provider} |
disconnect_provider |
| GET | /api/connections/oauth/callback |
oauth_landing |
| GET | /oauth-callback.js |
oauth_script |
| POST | /api/connections/oauth/callback |
oauth_callback |
| GET | / |
home |
| GET | /app.js |
script |
| GET | /question-box.js |
question_box_script |
| GET | /question-box.css |
question_box_style |
| GET | /brand/rocoto-mark.svg |
logo |
| GET | /fonts/fraunces/fraunces-latin-500-700.woff2 |
wordmark_font |
| GET | /connection-brands/{filename} |
connection_brand |
| GET | /vendor/{filename:path} |
vendor |
| GET | /assets/chat-dreamscape.png |
workspace_artwork |
| GET | /assets/search-dreamscape.png |
workspace_artwork |
| GET | /assets/monet-water-lilies.jpg |
empty_state_artwork |
| GET | /style.css |
style |
| GET | /business-summary.js |
interface_component |
| GET | /business-summary.css |
interface_component |
| GET | /settings-shell.js |
interface_component |
| GET | /settings-shell.css |
interface_component |
| GET | /harness-shell.js |
interface_component |
| GET | /workspace-tabs.js |
interface_component |
| GET | /workspace-extensions.js |
interface_component |
| GET | /wake-controls.js |
interface_component |
| GET | /wake-controls.css |
interface_component |
| GET | /workspace-tabs.css |
interface_component |
| GET | /workspace-home.js |
interface_component |
| GET | /workspace-home.css |
interface_component |
| GET | /display-charts.js |
interface_component |
| GET | /display-charts.css |
interface_component |
| GET | /display-canvas.js |
interface_component |
| GET | /display-canvas.css |
interface_component |
| GET | /tool-trail.js |
interface_component |
| GET | /tool-trail.css |
interface_component |
| GET | /rich-content.js |
interface_component |
| GET | /rich-content.css |
interface_component |
| GET | /rich-diagram.js |
interface_component |
| GET | /profile-settings.js |
interface_component |
| GET | /profile-settings.css |
interface_component |
| GET | /plugin-settings.js |
interface_component |
| GET | /plugin-settings.css |
interface_component |
| GET | /messaging-settings.js |
interface_component |
| GET | /messaging-settings.css |
interface_component |
| GET | /workspace-settings.js |
interface_component |
| GET | /workspace-settings.css |
interface_component |
| GET | /business-map.js |
interface_component |
| GET | /business-map.css |
interface_component |
| GET | /rich-diagram.html |
diagram_component |
| GET | /static/vendor/{filename:path} |
shared_vendor |
| GET | /api/source-icon |
source_icon |
| GET | /theme.css |
theme |
| GET | /healthz |
health |
| GET | /api/session |
session_info |
| POST | /api/session |
login |
| POST | /api/session/demo |
demo_session |
| DELETE | /api/session |
logout |
| POST | /api/session/company |
select_environment |
| POST | /api/environment |
select_environment |
| GET | /api/observers |
observers |
| POST | /api/observer |
observe |
| DELETE | /api/observer |
end_observation |
| GET | /api/status |
status |
| GET | /api/business |
business |
| GET | /api/business/map |
business_map |
| POST | /api/business/profile |
business_profile |
| POST | /api/business/onboarding |
onboarding |
| GET | /api/profile/activity |
profile_activity |
| GET | /api/usage |
usage |
| POST | /api/usage/settings |
usage_settings |
| GET | /api/skills/catalogue |
skills_catalogue |
| GET | /api/skills |
skills_installed |
| POST | /api/skills/install |
skills_install |
| GET | /api/ready-agents |
agent_catalogue |
| GET | /api/agents/catalogue |
agent_catalogue |
| GET | /api/workspace/capabilities |
workspace_capabilities |
| GET | /api/agents |
agents_list |
| POST | /api/agents |
agents_create |
| GET | /api/agents/{agent_id} |
agent_details |
| POST | /api/agents/{agent_id}/update |
agent_update |
| POST | /api/agents/{agent_id}/activate |
agent_activate |
| POST | /api/agents/{agent_id}/run |
agent_run |
| POST | /api/agents/{agent_id}/pause |
agent_pause |
| GET | /api/agents/{agent_id}/runs/{run_id}/report |
agent_report |
| POST | /api/chat |
chat |
| GET | /api/chats |
chats |
| POST | /api/chats/{chat_id}/metadata |
chat_metadata |
| GET | /api/chats/{chat_id} |
child_chat |
| POST | /api/chats/{chat_id}/approvals/{request_id} |
answer_native_approval |
| POST | /api/chats/{chat_id}/questions/{request_id} |
answer_native_question |
| POST | /api/chats/{chat_id}/credential-requests/{request_id} |
answer_credential_request |
| POST | /api/chat/{chat_id}/stop |
stop_chat |
| POST | /api/chat/{chat_id}/steer |
steer_chat |
| POST | /api/attachments |
attachment |
| GET | /attachments/{attachment_id}.png |
attachment_image |
| GET | /api/files |
list_files |
| GET | /api/files/{file_id} |
get_file |
| GET | /api/files/{file_id}/content |
file_content |
| PATCH | /api/files/{file_id} |
rename_file |
| POST | /api/files/{file_id}/opened |
mark_file_opened |
| GET | /api/files/{file_id}/download |
download_file |
| GET | /api/files/{file_id}/preview |
preview_file |
| GET | /api/retail/catalog/setup |
setup |
| POST | /api/retail/catalog/import |
import_catalog |
| POST | /api/retail/catalog/import-file |
import_file |
| POST | /api/retail/catalog/photo-handoff |
handoff |
| GET | /api/retail/catalog/shelf-crops/{key}/{index}/image |
shelf_crop |
| GET | /api/retail/catalog/photos/{key}/image |
photo |
| GET | /static/retail/catalog-upload.css |
mobile_style |
| GET | /static/retail/catalog-upload.js |
mobile_script |
| GET | /pages/retail/catalog-upload/{environment} |
mobile_page |
| POST | /pages/retail/catalog-upload/{environment} |
mobile_upload |
| GET | /api/catalog/inspections/{inspection_id}/image |
item_image |
| GET | /api/retail/viewer/bootstrap |
bootstrap |
| GET | /api/retail/viewer |
control_room_status |
| GET | /api/tiles/revision |
control_room_revision |
| GET | /control-room/ |
control_room_asset |
| GET | /control-room/{asset:path} |
control_room_asset |
| GET | /api/retail/source-links |
listing |
| POST | /api/retail/source-links |
create |
| GET | /api/retail/source-links/{identity} |
detail |
| POST | /api/retail/source-links/{identity}/retry |
retry |
| DELETE | /api/retail/source-links/{identity} |
cancel |
| GET | /api/retail/location/weather |
location_weather |
| GET | /api/retail/location/map |
location_map |
| GET | /api/retail/location |
location |
| GET | /api/retail/catalog/products |
catalog |
| GET | /api/retail/visit-basket |
visit_basket |
| GET | /api/retail/monitoring/profiles |
profiles |
| POST | /api/retail/monitoring/profiles |
create_profile |
| GET | /api/retail/monitoring/profiles/{profile_id} |
profile |
| POST | /api/retail/monitoring/profiles/{profile_id} |
update_profile |
| GET | /api/retail/monitoring/events |
events |
| GET | /api/retail/monitoring/events/{event_id} |
event |
| POST | /api/retail/monitoring/events |
commit_event |
| GET | /api/agents/{agent_id}/observations |
observations |
| POST | /api/agents/{agent_id}/presentation |
save_presentation |
| POST | /api/chats/{chat_id}/promote-agent |
promote |
| GET | /api/retail/visit-basket |
legacy_basket |
| GET | /api/retail/realtime/sources/{source_id}/epochs/{epoch_id}/snapshot |
epoch_snapshot |
| GET | /api/retail/realtime/sources/{source_id}/assets/{asset_id}/snapshot |
asset_snapshot |
| POST | /api/retail/business/settings |
business_settings |
| POST | /api/retail/business/connections |
business_connection |
| POST | /api/retail/search |
search |
| POST | /api/retail/cameras/review |
review_cameras |
| POST | /api/retail/exports |
prepare_export |
| GET | /api/retail/exports |
list_exports |
| GET | /api/retail/inspection-previews/{receipt_id}/{index}.jpg |
inspection_preview |
| GET | /api/retail/exports/{payload_id} |
get_export |
| GET | /api/retail/exports/{payload_id}/download |
download_export |
| GET | /api/retail/cameras |
cameras |
| GET | /api/retail/cameras/{camera_id} |
camera_details |
| POST | /api/retail/cameras/{camera_id}/context |
camera_context_draft |
| POST | /api/retail/cameras/{camera_id}/confirm |
confirm_camera_context |
| GET | /api/retail/library |
source_library |
| GET | /api/retail/assets/{asset_id} |
source_asset |
| GET | /clips/{clip_id}.mp4 |
evidence_clip |
| GET | /thumbnails/{clip_id}.jpg |
thumbnail |
| GET | /downloads/{clip_id}.mp4 |
download_clip |
| GET | /api/retail/clip/{clip_id}/manifest |
download_manifest |
| GET | /api/retail/clip/{clip_id} |
clip_details |
| GET | /originals/{asset_id} |
original_source |
| GET | /static/retail/assets/demo-companies/sij-acroni.png |
sij_acroni_logo |
| GET | /static/retail/control-room.js |
control_room_script |
| GET | /static/retail/assets/camera-providers/{filename} |
camera_provider_asset |
| GET | /static/retail/retail-scope.js |
retail_scope_component |
| GET | /static/retail/retail-scope.css |
retail_scope_component |
| GET | /static/retail/retail-ui.js |
retail_component |
| GET | /static/retail/retail-ui.css |
retail_component |
| GET | /static/retail/retail-shell.js |
retail_component |
| GET | /static/retail/tracker-canvas.js |
retail_component |
| GET | /static/retail/tracker-canvas.css |
retail_component |
| GET | /static/retail/camera-streams.js |
retail_component |
| GET | /static/retail/camera-streams.css |
retail_component |
| GET | /api/retail/scope |
graph |
| GET | /api/retail/scope/events |
graph_events |
| POST | /api/retail/scope/{kind} |
change |
| GET | /api/retail/chats/{chat_id}/scope |
chat_scope |
| PUT | /api/retail/chats/{chat_id}/scope |
change_chat_scope |
| GET | /api/retail/library/imports |
imports |
| POST | /api/retail/library/imports |
begin |
| GET | /api/retail/library/imports/{upload_id} |
detail |
| PATCH | /api/retail/library/imports/{upload_id}/content |
content |
| POST | /api/retail/library/imports/{upload_id}/complete |
complete |
| DELETE | /api/retail/library/imports/{upload_id} |
cancel |
| GET | /api/retail/sources |
sources |
| POST | /api/retail/sources |
add_source |
| GET | /api/retail/sources/{source_id} |
source |
| GET | /api/retail/storage/{connector_id} |
status |
| POST | /api/retail/storage/{connector_id}/approve |
approve |
| POST | /api/retail/storage/{connector_id}/run |
run |
| POST | /api/retail/storage/{connector_id}/pause |
pause |
| GET | /sources/{source_id}/assets/{asset_id}/snapshot |
source_snapshot |
| GET | /sources/{source_id}/epochs/{epoch_id}/snapshot |
epoch_snapshot |
| GET | /replays/{run_id} |
replay_status |
Configuration
Values belong in recipient-owned private runtime configuration.
DATABASE_URL, ROCOTO_AGENT_AUTH_MODE, ROCOTO_BROWSE_SESSIONS, ROCOTO_BUILTIN_CAPABILITIES_CONFIG, ROCOTO_CAPABILITY_SPEND_CONFIG, ROCOTO_CONNECTION_WRITE_PROVIDERS, ROCOTO_CUSTOM_EXECUTOR_ENABLED, ROCOTO_DOCUMENT_PREVIEWS_ENABLED, ROCOTO_DOCUMENT_PREVIEW_RECEIPT_SHA256, ROCOTO_MANAGED_SPENDING_MODE, ROCOTO_MESSAGING_CONFIG, ROCOTO_NATIVE_WRITE_PROVIDERS, ROCOTO_OPENAI_API_KEY, ROCOTO_OPERATOR_ID, ROCOTO_OPERATOR_NAME, ROCOTO_PHONE_SPEND_CONFIG, ROCOTO_PUBLIC_ORIGIN, ROCOTO_STATE_DIRECTORY, ROCOTO_VIDEO_DEMO_BROWSING, ROCOTO_VIDEO_MESSAGING_CONFIG, ROCOTO_VIDEO_OPERATOR_NAME, ROCOTO_VIDEO_PHONE_SPEND_CONFIG, ROCOTO_VIDEO_PUBLIC_ORIGIN, RUNTIME_DATABASE_URL, VIDEO_OPERATIONS_MODAL_WORKSPACE, XDG_STATE_HOME
Definitions
backend/realtime/configuration.py
| Function | Arguments | Source description |
|---|---|---|
| maintained_core | self | |
| unique_ids | cls, values | |
| event_type | self | |
| unique_interests | self | |
| _clock | body | |
| _core_events | ||
| _zone_available | con, context, source_id, zone_id, kind | |
| _support | parameters, actual_input, tracker | |
| validate_admission | con, context, source_id, event | Enforce actual acknowledged configuration only for managed observations. |
| init | self, store | |
| _head | self, con, context, source_id | |
| _camera | self, con, context, source_id | |
| _capacity | self, con, context, body, records | |
| _validate | self, con, context, source_id, intent | |
| _compile | self, intent, validation | |
| requirements | self, context, source_id | |
| _bounded | context, body | |
| propose | self, context, source_id, proposal_id, raw_intent | |
| validate | self, context, source_id, proposal_id | |
| _proposal | self, con, context, source_id, proposal_id | |
| activate | self, context, source_id, proposal_id | Set desired configuration atomically. There is deliberately no enqueue. |
| _worker | self, con, context, source_id | |
| worker_configuration | self, context, source_id | Private adapter read. Never expose this shape through customer tools. |
| acknowledge | self, context, source_id, raw_ack | |
| status | self, context, source_id, limit |
backend/realtime/continuity.py
| Function | Arguments | Source description |
|---|---|---|
| bounded_ids | self | |
| complete_clock | self | |
| preserve_existing_receipts | self, handler | |
| retained_configuration | self | |
| same_elapsed_time | self | |
| preserve_existing_intervals | self, handler | |
| reported_frame_s | run, frame | Source time of one frame in a retained run: its start plus frame index over frame rate. |
| reported_birth_id | namespace, sidecar_sha256, tracker_id, first_frame | Identify the first report in one retained run, independently of physical entry. |
| _contains | outer, inner | |
| _stream_window | mapping, local | |
| init | self, store | |
| _epoch | self, con, context, source_id, epoch_id | |
| _mapping | self, con, context, source_id, mapping_id | |
| _room | self, con, context, body | |
| _retry | self, con, context, table, key, source_id, value, body | |
| start_epoch | self, context, source_id, record | |
| end_epoch | self, context, source_id, record | |
| map_artifact | self, context, source_id, record | |
| _validate_clock | self, con, context, source_id, asset, local, lineage | |
| validate_input | self, con, context, source_id, body | |
| event_reason | self, con, context, source_id, event, replay_context | |
| _track_evidence | self, con, context, source_id, receipt_id, receipt_sha, tracker_id, birth_id, window, state | |
| validate_visit | self, con, context, record, attrs | |
| record_segment | self, context, source_id, record | |
| validate_binding | self, con, context, source_id, event, subject | |
| _playback_rows | self, con, context, source_id, epoch_id, playhead, table | |
| _playback | self, con, context, source_id, epoch_id, playhead | Fresh tracker-only descriptor under current RLS and subject lifecycle. |
| intervals | mapping, local | |
| playback | self, context, source_id, epoch_id, at_s | Read receipt-backed selectable visitors, even with zero admitted activities. |
| segments | self, context, source_id, visit_subject_id, limit |
backend/realtime/contracts.py
| Function | Arguments | Source description |
|---|---|---|
| _opaque_id | value | Validate an opaque existing identifier without assigning it semantics. |
| _utc_datetime | value | |
| _finite_decimal | value | |
| _validate_capabilities | cls, values | |
| _validate_deadline | cls, value | |
| _validate_finite | cls, value | |
| _validate_order | self | |
| _preserve_recording_wire | self, handler | |
| _validate_receipts | cls, values | |
| _validate_effective_at | cls, value | |
| _validate_event_refs | cls, values | |
| _validate_json_value | value, depth, ancestors | Validate JSON shape, finite numbers, depth, and cycles before encoding. |
| _encoded_json | value, label | |
| _validate_timestamps | cls, value | |
| _validate_event_type | cls, value | |
| _serialize_event | self, handler | |
| _validate_envelope | self | |
| _validate_changes | cls, value |
backend/realtime/identity.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, code, message | |
| post_init | self | |
| from_context | cls, context, environment | Convert the existing trusted platform-owner require_owner result. |
| _identifier | value, field | |
| _email | value | |
| _reason | value | |
| _fingerprint | company_id, operator_id, email, reason | |
| _require_control_connection | connection | Fail closed when a runtime role reaches this control-plane mutation. |
| reconcile_verified_login | connection, company_id, operator_id, verified_email, owner, request_id, reason | Bind verified_email to one existing imported operator. |
backend/realtime/import_stream.py
| Function | Arguments | Source description |
|---|---|---|
| canonical | value | |
| digest | value | |
| raw_digest | value | |
| checked_json | value, maximum | |
| identity_record | value | |
| _read_db | path | |
| _has_table | con, name | |
| _reference | event | |
| _profile_key | profile_id, revision | |
| export_snapshot | state, identity_path, owner, source_ids, export_reference | Read committed native admissions from a host-selected private snapshot. |
| validate_export | manifest, expected_sha256 | Validate a reviewed neutral artifact; its checksum is integrity, not authorization. |
| _utc | seconds | |
| plan_import | manifest, expected_sha256 | Create inspectable SDK commands; empty exports remain explicitly empty. |
| import_export | context, manifest, expected_sha256, dry_run, retained_export_path, store | Apply idempotent SDK phases after host identity commissioning and review. |
| write_export | path, manifest | Retain private raw admission evidence before using the import service. |
| main | Read-only source export CLI; database import stays an authenticated host call. |
backend/realtime/import_tracker_run.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, code, message | |
| _need | condition, code, message | |
| _sha | data | |
| _whole | value, low, high | |
| _entry | root, relative | One retained path below the resolved run root, reached through real directories. |
| _read | root, relative, limit | |
| _media | root, relative | |
| _json | data, relative | |
| sidecar_digest | files | One sealed digest of a per-frame tracker directory, from (name, bytes) pairs. |
| _frame_rows | data, relative | The tracker rows of one frame file, in the producer's own record shape. |
| _sidecar | root, relative, count | |
| _reports | frames | Each raw tracker ID with its runs of consecutive reported frames, end exclusive. |
| _recording | record, listed, clip | The producer's own run receipt: one complete recording on an exact frame clock. |
| _application | data, clip, record | The retained application configuration names this view's media, sidecar and one pass. |
| value | section, name | |
| _end_of_stream | data, clip | |
| _tracks | value, clip, record, frames | The producer's JSON conversion agrees with the per-frame sidecar, row for row. |
| _sample_mapping | value, clip, record | Every encoded frame names the publisher frame it holds, on the encoded clock. |
| _inventory | root | |
| identifiers | clip | The stable identifiers of one view. Content hashes stay out of every identifier. |
| _verify_view | root, clip, listed, shared | Read and verify one view's retained evidence. Every check precedes any record. |
| _plan_view | root, clip, listed, shared | State the exact SDK records one verified view becomes. |
| evidence | name, sha256 | |
| subject | registration | |
| plan_run | run_root, reference, company_id, principal_id, clips | Verify the retained run and plan every record. Reads files only. |
| summary | plan | The reviewable plan: identifiers, sealed hashes, counts and visitor boundaries per view. |
| require_reviewed | plan, expected_sha256 | The checksum is integrity of the reviewed dry run; authority stays with the database. |
| _context | plan | |
| _authority | context, store | The restricted role, a commissioned company and a principal that configures and ingests. |
| _retained | context, store, view | Compare every record this view already holds with its plan, before any write. |
| _rows | context, store, source_id | |
| _import_view | context, store, view | One view through the maintained SDK. Every call returns its retained record on a retry. |
| import_run | plan, store | Import every planned view, or refuse the whole run before its first write. |
| _identity | path | |
| _receipt_path | value, root | A new file in an existing folder outside the repository and outside the retained run. |
| _write_receipt | path, receipt | |
| _apply | plan, dsn | Open only the restricted pool for this command's lifetime. |
| main | argv |
backend/realtime/locations.py
| Function | Arguments | Source description |
|---|---|---|
| _tracker_keys | cls, value | |
| _size | value | UTF-8 bytes of a document as PostgreSQL prints jsonb. |
| _document | value, limit, name | |
| _listing | value, limit, name | |
| _sha | value | |
| _iso | moment | |
| _day | value | |
| _stamp | value | |
| _keys | value | |
| _moment | value | An ISO 8601 time with its offset, as a record's body carries it. |
| _run | row | A run as the tools and the page read it: no principal, no stamp, no lease. |
| _tracker | row | |
| _order | tracker | |
| _flags | tracker | |
| init | self, store | |
| _tx | self, context, capability | One scoped transaction; a refusal of the tables arrives as the SDK's own error. |
| _location | self, con, context, location_id, lock, reach | The location row behind the wall. reach names the capability a write takes on each camera. |
| _budget | self, con, context, limits, added | |
| _bump | con, context, location_id | A tracker change moves what a commit expects and what the page shows. |
| _identity | row | |
| register_location | self, context, location_id, collection, business_type | Give a location its PostgreSQL identity. An exact retry returns the same row. |
| bind_source | self, context, location_id, source_id, camera_id, body | Bind one camera source to its location. A camera belongs to one location. |
| locations | self, context | The company's locations this principal reads, with how many trackers each holds. |
| _definition | definition | |
| _trackers | self, con, context, location_id, include_retired | |
| _one_tracker | self, con, context, tracker_id | |
| install_trackers | self, context, location_id, definitions | Record tracker definitions for a location. An exact retry returns the same rows. |
| _revision | con, context, location_id, item, part, revision | |
| save_revision | self, context, tracker_id, part, body, expected_revision | Append the next revision of one part of a company's tracker. |
| activate | self, context, tracker_id, expected_head, definition, script, presentation, state | Point a company's tracker at saved revisions or change its state, as one head move. |
| trackers | self, context, location_id, include_retired | The location's trackers with their active revision bodies: Core first, then by key. |
| _records | kind, rows, basis, occurred_key, source_key | |
| _write_records | self, con, context, limits, location_id, kind, basis, prepared, replace_all | Insert new rows, rewrite changed ones, and turn the rows that left a rebuild inactive. |
| put_records | self, context, location_id, kind, rows, basis, replace_all, occurred_key, source_key | Write ingested or configured records of one kind; returns how many rows changed. |
| load | self, context, location_id | Everything one tracker run reads, bounded by the context's event and byte limits. |
| _output | value | |
| commit | self, context, location_id, changes, run_id, lease_token, expected_run_seq | Commit one run in one transaction: all of it lands, or the location stays as it was. |
| home | self, context, location_id, known_revision | The page keys of a location with their revision. No event is read. |
| claim_events | self, context, location_id, limit, lease_seconds | Lease pending live outbox rows of location cameras, grouped by location. |
| input_stamp | self, context, location_id | A digest of what a run of this location reads. It moves when an input is added or changed. |
| _state | self, con, context, location_id, now | |
| state | self, context, location_id, now | The location's schedule as the probe and the tools read it. Times are epoch seconds. |
| policy | self, context, location_id | The location's run policy with its revision. |
| set_policy | self, context, location_id, changes, expected_revision | Change the location's run policy. expected_revision is the revision the caller read. |
| request | self, context, location_id, by, only | Ask for a pass now. Requests made before the pass starts become that one pass. |
| claim | self, context, location_id, trigger, stamp, day, lease_seconds | Take the location's lease and open a run. None while another pass holds the lease. |
| finish | self, context, run_id, lease_token, status, stamp, day, period, derived, outputs, errors, skipped, wall_ms, error, published | Close a run and free its lease; the holder's token is the key. |
| runs | self, context, location_id, limit | The location's runs, newest first. The newest 200 are kept. |
| last_run | self, context, location_id | The newest run of one location, or of the company's locations this principal reads. |
backend/realtime/media.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, store | |
| bindings | self, context, references | Join each reference to its current source grant, active camera, epoch and mapping. |
backend/realtime/module_store.py
| Function | Arguments | Source description |
|---|---|---|
| _json_bytes | value, limit | |
| _wire | value | Round-trip JSON values so asyncpg/Decimal values cannot escape the API. |
| _bounded_digest | value | Hash the full bounded wire, without the small event helper limit. |
| _playhead | value | |
| init | self, store | |
| _lane | source | |
| _original_source | source, source_id | |
| _context_key | value | |
| _epoch_asset_id | epoch_id | |
| _history | self, con, context, source_id, source_asset_id, max_events, epoch_id | Read a bounded cursor after latest-revision selection. |
| _binding_manifest | bindings, current_revisions | |
| _result | self, row, context, status | |
| _collect | self, con, context, source_id, asset_id, playhead, epoch_id | |
| _pending | collected, playhead | |
| _empty | collected, playhead | |
| _ephemeral_result | self, collected, context, playhead | |
| project_at | self, context, source_id, asset_id, at_s | Read an ephemeral source-time projection without creating a row. |
| _verify_epoch | self, con, context, source_id, epoch_id | |
| _with_playback | self, con, context, source_id, epoch_id, result, playhead | |
| project_epoch_at | self, context, source_id, epoch_id, at_s | Read an epoch projection at stream time without creating a row. |
| refresh_epoch | self, context, source_id, epoch_id, at_s | Persist one tracker epoch ordered by its host stream clock. |
| latest_epoch | self, context, source_id, epoch_id, at_s | Read the stored head for an epoch namespace. |
| refresh | self, context, source_id, asset_id, at_s | Persist the canonical head; playhead reads use :meth:project_at. |
| _authorize_manifest | self, con, context, source_id, manifest | Recheck every retained subject dependency through its current grant. |
| _fetch_bounded_projection | self, con, context, projection_id | Preflight size and current dependency grants before fetching snapshot JSON. |
| get | self, context, projection_id | Read one projection through its current source grant. |
| latest | self, context, source_id, asset_id, at_s | Read the canonical stored head; source-time reads are ephemeral. |
backend/realtime/modules.py
| Function | Arguments | Source description |
|---|---|---|
| _number | value | |
| _text | value, fallback | |
| _reference | event | |
| _subject | binding | |
| _one | bindings, role | |
| project_observations | facts, at_s | Return JSON-safe journey, basket, interest and stock views as of source time. |
| visit | subject | |
| observe | v, start, end | |
| close_interval | v, name, end, ref | |
| wire | value | |
| project_continuous_observations | facts, at_s, epoch_id | Project one tracker epoch across rotated artifacts on its stream clock. |
backend/realtime/provision.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, code, message | |
| _text | value, field, maximum | |
| _timestamp | value | |
| _manifest | saved_identity, principals, environment_alias, display_name, migration_source | |
| _conflict | code, message | |
| import_workspace_identity | connection, saved_identity, principals, environment_alias, display_name, migration_source, migration_role | Import once or validate an exact retry, without committing the caller's transaction. |
backend/realtime/provision_host.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, code, message | |
| _identity | info | |
| _open_private | state, parts, maximum | Open one private regular file below the state directory, following no symbolic link. |
| read_identity | state, environment | The saved workspace identity and the SHA-256 of its exact bytes. |
| read_principals | state, environment | The environment's display name and its principals, from an unchanged read-only store. |
| _sha256 | value | |
| _tool_digests | ||
| _connect | dsn | |
| _reserve_receipt | path | |
| _validate | options, dsn | |
| _import | connection, options, arguments | |
| import_identity | options, dsn, connect | Run the dry run or the real import and return its receipt. |
| parser | ||
| main | argv, environ |
backend/realtime/read_contract.py
| Function | Arguments | Source description |
|---|---|---|
| bounded_playhead | value | Accept finite nonnegative source seconds within the public wire bounds. |
| public_projection | result, epoch_id | Expose business data and playback evidence, keeping private lineage inside the SDK. |
backend/realtime/replay.py
| Function | Arguments | Source description |
|---|---|---|
| _seconds | value, positive | |
| _id | value | |
| _json | value | |
| _unsupported | value | |
| _key | prefix, *values | |
| replay_context_dict | context | Omit absent optional fields to preserve already-compiled plan/event hashes. |
| _planned_dict | event | |
| canonical_event | self | |
| to_dict | self | |
| to_dict | self | |
| from_dict | cls, value | |
| _reference | value | |
| compile_replay | company_id, run_id, sources, receipts, records, loops, rate, readiness_lag_s | Compile accepted history; emit only after every actual input window ends. |
| initial_cursor | plan | |
| due_events | plan, cursor, elapsed_s, limit | Return due work plus an uncommitted checkpoint; never advance on reads. |
| seek | plan, elapsed_s | Inspect a playback position without skipping or rewinding committed work. |
| restore_plan | value | Restore an immutable database plan and verify its compiler digest/identities. |
| exact | model, data |
backend/realtime/replay_store.py
| Function | Arguments | Source description |
|---|---|---|
| _wire | value | |
| _unsupported | value | |
| _bytes | value | |
| init | self, store | |
| _request | sources, loops, rate, readiness_lag_s | |
| _load_inputs | self, con, context, sources, loops | |
| start | self, context, run_id, sources, loops, rate, readiness_lag_s | Persist one immutable plan, commission its sources, then start the DB clock. |
| _prepare | self, context, run_id, plan | |
| _elapsed | row, now | |
| _row | self, con, context, run_id, lock, include_plan | |
| _status | row | |
| get | self, context, run_id | |
| inspect_plan | self, context, run_id | |
| tick | self, context, run_id, limit | |
| pause | self, context, run_id, expected_revision | |
| resume | self, context, run_id, expected_revision | |
| _set_paused | self, context, run_id, expected_revision, paused |
backend/realtime/replay_worker.py
| Function | Arguments | Source description |
|---|---|---|
| _pairs | plan | |
| _summary | result | Return a bounded receipt without copying the potentially large snapshot. |
| init | self, replay, modules | |
| run_once | self, context, run_id, limit | |
| run_once | context, run_id, limit | Convenience boundary for a scheduled ordinary-host invocation. |
backend/realtime/routes.py
| Function | Arguments | Source description |
|---|---|---|
| _principal_id | ctx | Resolve the session's verified email to the durable imported principal. |
| _context | request, ctx | |
| _read_context | request, ctx | |
| _error | exc | |
| source_snapshot | source_id, asset_id, request, at_s, context | |
| epoch_snapshot | source_id, epoch_id, request, at_s, context | Read one admitted continuous session on its mapped stream clock. |
| replay_status | run_id, request, context |
backend/realtime/store.py
| Function | Arguments | Source description |
|---|---|---|
| scope_for_company | company_id | Preserve safe canonical labels; otherwise use a collision-resistant label. |
| _encoded | value, limit | |
| _digest | value | |
| _identifier | value | |
| _transaction | self, context, capability | |
| _source | self, con, context, source_id, writing | |
| register_source | self, context, source_id, kind, metadata | |
| register_profile | self, context, source_id, revision_id, event_types | |
| _register_profile | self, con, context, source_id, revision_id, event_types | |
| record_receipt | self, context, source_id, receipt_id, body | |
| _lock_budget | self, con, context | |
| _usage | self, con, context | |
| _check_bytes | limits, usage, added | |
| _evidence_reason | self, con, context, source_id, event, replay_context | |
| admit | self, context, source_id, event | |
| _admit | self, con, context, source_id, event, replay_context | |
| depth | value | |
| read_events | self, context, source_id, after_sequence, limit | |
| claim_outbox | self, context, limit, lease_seconds, lane | |
| finish_outbox | self, context, outbox_id, lease_token |
backend/realtime/subjects.py
| Function | Arguments | Source description |
|---|---|---|
| _preserve_recording_identity | self, handler | |
| quantity_evidence | self | |
| identity | self | |
| interval | self | |
| typed | self | |
| _identity | record | |
| init | self, store | |
| _read | self, con, context, subject_id, revision | |
| get | self, context, subject_id, revision | |
| _budget | self, con, context, additional_bytes | |
| register | self, context, registration, expected_revision | |
| _evidence | self, con, context, record, attrs, parent_record | |
| bind_event | self, context, source_id, event_id, event_revision, bindings | |
| _bind_event | self, con, context, source_id, event_id, event_revision, bindings | |
| _validate_binding | self, con, context, source_id, event, binding, subject | |
| _event_bindings | self, con, context, source_id, event_id, event_revision | |
| event_bindings | self, context, source_id, event_id, event_revision | |
| replay_entities | self, context, source_id, event_id, event_revision | |
| _replay_entities | self, con, context, source_id, event_id, event_revision | |
| copy_replay_event | self, context, source_id, event_id, event_revision | |
| _copy_replay_event | self, con, context, source_id, event_id, event_revision | Copy and seal with event admission/cursor in the caller's transaction. |
| copy | subject |
harness/deploy/build_preview.py
| Function | Arguments | Source description |
|---|---|---|
| source_paths | repo, prefix | Use Git in a checkout or the explicit reviewed inventory in a source export. |
| maintained_read_files | repo | Package the shared read closure, the host commands and the immutable schema chain. |
| artifact_root | vertical_id | |
| artifact_destination | repo, output, source, vertical_id | |
| source_layout | here, vertical_id | Use the runtime's layout rather than maintaining a second folder inventory. |
| template_files | here, vertical_id | Every file the selected vertical declares, including Python and prompts. |
| artifact_files | repo, here, vertical_id | Tracked shared code/assets and the selected vertical, with missing Python reported. |
| copy_artifact | repo, output, selected, vertical_id | Copy each selected regular file to its place in the artifact layout. |
| build_output | here, vertical_id | |
| build | vertical_id |
harness/deploy/connections/configure_google.py
| Function | Arguments | Source description |
|---|---|---|
| save_registration | state, directory, client_id, client_secret, public_origin | |
| main |
harness/deploy/document-preview/closure/broker_service.py
| Function | Arguments | Source description |
|---|---|---|
| main |
harness/deploy/document-preview/closure/document_preview_contract.py
| Function | Arguments | Source description |
|---|---|---|
| post_init | self | |
| parse | cls, value | |
| validate_manifest | manifest, files, request, original_sha256, original_bytes | |
| require | condition |
harness/deploy/document-preview/closure/native_executor.py
| Function | Arguments | Source description |
|---|---|---|
| post_init | self | |
| key | self | |
| post_init | self | |
| name | self | |
| _command | timeout, input, *argv | |
| init | self, root, size_bytes | |
| mount | self, key | |
| unmount | self, volume | |
| init | self, volumes | |
| mount | self, key | |
| volume_path | self, key | |
| unmount | self, volume | |
| inspect | self, spec | |
| flags | spec | |
| start | self, spec, capability | |
| pause | self, spec | |
| unpause | self, spec | |
| stop | self, spec | |
| _path_parts | value | |
| _checked_directory | parent, name, uid | |
| snapshot_outputs | workspace, destination, uid, paths | Snapshot owned ordinary files without following a mutable path or symlink. |
| copy_file | parent, name, relative | |
| walk | parent, prefix, depth | |
| init | self, root, run_root, backend, app_uid, app_gid, clock, socket_owner, socket_group | |
| _row | self, key | |
| _spec | self, row | |
| _update | self, key, status, volume | |
| _validate | self, scope, lease | |
| prepare | self, scope | |
| _freeze_sockets | self, spec | |
| install_packages | self, scope, lease, reader, writer | Reserve the lease before accepting a bounded stream; no host paths. |
| start | self, scope, lease, capability | |
| _stop_row | self, row | |
| stop | self, scope, lease | Caller revokes model/MCP grants first; removal kills the whole process tree. |
| reconcile | self | After broker restart, remove every recorded worker before accepting input. |
| expire_prepared | self | |
| snapshot | self, scope, lease, paths | |
| output_file | self, scope, lease, snapshot_id, index | |
| _read_package_frame | reader, limit | |
| _read_frame | reader | |
| _write_frame | writer, kind, body | |
| init | self, broker, path | |
| start | self | |
| expire | ||
| close | self | |
| _connection | self, reader, writer | |
| _fields | value, allowed | |
| _reply | writer, value | |
| _relay | process, reader, writer | |
| stdin | ||
| output | source, kind | |
| init | self, writer | |
| write | self, data | |
| drain | self | |
| write_eof | self | |
| close | self | |
| init | self, client, scope, lease, reader, writer | |
| _pump | self | |
| wait | self | |
| stop | self | |
| init | self, socket_path | |
| _connect | self, operation, scope, lease, **values | |
| _request | self, operation, scope, lease, **values | |
| prepare | self, scope | |
| install_packages | self, scope, lease, selection | |
| start | self, scope, lease, gateway_capability | |
| stop | self, scope, lease | |
| snapshot | self, scope, lease, paths | |
| read_output | self, scope, lease, snapshot_id, index |
harness/deploy/document-preview/closure/native_package_mount.py
| Function | Arguments | Source description |
|---|---|---|
| encoded | value | |
| digest | value | |
| parts | value | |
| validate_metadata | value, company, owner | |
| selection_metadata | selection | |
| _read_json | path | |
| native_config | root, metadata | Enable original skills; explicitly disable every bundled MCP server. |
| seal | root | |
| ensure_mount_target | volume | Never follow model-created links when preparing Docker's nested target. |
| open_source | root, relative | Held descriptor chain prevents app-owned source symlinks from redirecting. |
| toml_value | value | Codex -c expects TOML values; JSON object colons are not TOML assignments. |
harness/deploy/document-preview/closure/source_media.py
| Function | Arguments | Source description |
|---|---|---|
| _require | condition, code | |
| _identifier | value, pattern | |
| _number | value | |
| _json | value | |
| post_init | self | |
| key | self | |
| post_init | self | |
| post_init | self | |
| parse | cls, value | |
| manifest_request | self, scope, collection, checksum | |
| wall_seconds | self | |
| image | self | |
| arguments | self | |
| name | self | |
| original | self | |
| output | self | |
| init | self, root | |
| volume_path | self, key, generation | |
| mount | self, spec | |
| flags | self, spec | |
| start | self, spec | |
| wait | self, spec | |
| stop | self, spec | |
| present | ||
| unmount | self, spec | |
| _directory | path | |
| _identity | info | |
| _copy_original | fd, destination, uid, size, checksum | |
| _read_json | path, limit | |
| _validate_manifest | manifest, files, scope, collection, size, checksum, sealed | |
| _validate_derived_manifest | manifest, files, scope, collection, size, checksum, request | Validate fixed-profile claims and sealed byte hashes without media decoding. |
| dimensions | row | |
| source_frame | frame | |
| _snapshot | spec, scope, size, checksum, worker_uid | Copy ordinary files only after the whole worker is confirmed absent. |
| _drain | task | Finish an owned bounded operation even after repeated cancellation. |
| init | self, root, backend, app_uid, app_gid, clock, worker_uid, document_previews | |
| _row | self, key | |
| _derivation_body | self, row | |
| _spec | self, row | |
| _valid | self, scope, lease | |
| _update | self, key, status, confirmed, error, result | |
| submit | self, scope, generation, collection, original_sha256, original_bytes, expires_at, original_fd | |
| derive | self, scope, generation, collection, original_sha256, original_bytes, expires_at, original_fd, derivation | |
| preview | self, scope, document, **values | |
| _submit | self, scope, generation, collection, original_sha256, original_bytes, expires_at, original_fd, derivation | |
| _expiry | self, expires | |
| heartbeat | self, scope, lease, expires_at | |
| _run | self, scope, row, spec | |
| enforce_expiry | ||
| cleanup | ||
| status | self, scope, lease | |
| stop | self, scope, lease | |
| _reconcile | self, row | |
| recover_lease | self, scope, generation | |
| recover | self | |
| output_file | self, scope, lease, index | |
| release | self, scope, lease | |
| close | self | |
| _send_packet | sock, payload | |
| _receive_packet | sock | |
| _send_json | sock, value | |
| _receive_json | sock | |
| _receive_request | sock, app_uid | |
| init | self, broker, path | |
| start | self | |
| _accept | self | |
| _connection | self, sock | |
| close | self | |
| init | self, socket_path, server_uid | |
| _connect | self, operation, scope, lease, original_fd, **values | |
| _exchange | self, operation, scope, lease, **values | |
| _request | self, operation, scope, lease, **values | |
| submit | self, scope, **values | |
| derive | self, scope, **values | |
| preview | self, scope, **values | |
| _admit | self, operation, scope, **values | |
| exchange | ||
| recover | self, scope, generation | |
| status | self, scope, lease | |
| heartbeat | self, scope, lease, expires_at | |
| stop | self, scope, lease | |
| release | self, scope, lease | |
| read_output | self, scope, lease, index | |
| _main | args |
harness/deploy/migrate_state.py
| Function | Arguments | Source description |
|---|---|---|
| _now | ||
| _hash | path | |
| _json | path | |
| _write | path, data | |
| _stamp | path | |
| _regular | path | |
| _sqlite_files | source | SHM is a reader/writer coordination cache, never database content. |
| _private_database | source | Let SQLite recover only a private, identity-checked database/WAL copy. |
| _workspace | relative | |
| _include | relative, indexed | |
| _check_idle | source | |
| _json_value | value | |
| _cosmos_generations | source | Verified committed indexes; retained/uncommitted directories stay at source. |
| inventory | source | Read-only selection audit; credentials and unindexed experiment media stay on dev. |
| _relocate | value, source, target, fields | |
| _backup | source, destination | |
| _relocate_database | path, source, target | Only mutable operational links move; immutable event bodies remain verbatim. |
| build_snapshot | source, bundle, target, quiesced, native_exports | |
| verify_snapshot | bundle, installed_root | |
| install_snapshot | bundle, target, quiesced | |
| export_native | source, output, codex_bin | Local thread/read only. No thread/start, turn, provider inference or auth export. |
| main |
harness/deploy/migration/app_server.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, process | |
| write | self, value, guard | |
| _read | self | |
| rpc | self, method, params, guard | |
| close | self |
harness/deploy/migration/config.py
| Function | Arguments | Source description |
|---|---|---|
| cli_args | config |
harness/deploy/migration/history.py
| Function | Arguments | Source description |
|---|---|---|
| _thread | response | |
| _image_mime | data | |
| _image | part, attachment_root, item_id | Copy existing references or owned attachment bytes; never fetch a URL. |
| _public_history | thread, cwd | |
| history_export | thread, state, chat_id, owner_principal_id | Export only host-owned public messages; never export credentials/native internals. |
| history_export_path | state, chat_id | |
| load_history_export | state, chat_id, existing_id, owner_principal_id | Accept one private host export only for the exact company/chat/owner/native binding. |
harness/deploy/migration/legacy/isolated_native.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, path | |
| call | self, scope, receive, send | |
| aenter | self | |
| aexit | self, *args | |
| init | self, scope, lease, launch, client, listener, stack, storage_scope | |
| thread_params | self, instructions, tools | |
| bind_mcp | self, app | Called once, in the lease task, after host verifies the native root ID. |
| drain_stderr | self | |
| stop | self | Safe from a separate Stop task; context managers exit on their owner. |
| init | self, auth, company_id, enabled, client, gateway_factory, package_store | |
| revoke_plugin | self, principal_id, plugin_id | HTTP removes selection first; failed Stops remain tracked for retry. |
| _selection | self, scope | |
| lease | self, scope, run_id, workspace_binding |
harness/deploy/migration/legacy/isolated_turn.py
| Function | Arguments | Source description |
|---|---|---|
| isolated_instructions | product | |
| portable_input | content, state | Embed only already-authorized attachment bytes; expose no host paths. |
| public_continuation | record | The native homes differ. Carry public messages once, never private state. |
| init | self, agent, chat_id, dataset, run, connection, session, root_thread | |
| admit | self, native_id, seen | |
| child_event | self, identity | |
| record_child | self, identity, event | |
| retire_questions | self, reason | |
| tool | self, item, actor | |
| event | self, item | Project one native event after independently admitting its actor. |
| settling | self | |
| settled | self | |
| expire_questions | self | |
| active | ||
| deliver | native_id, response | |
| stream | self | |
| close | self | |
| cleanup_tracked_lease | launcher, scope, run | Record the launcher's confirmed broker cleanup independently of readiness. |
| run_isolated | agent, message, chat_id, dataset, attachments, clip_attachments, resolved_skills, model_context | |
| timing |
harness/deploy/migration/legacy/managed_executor.py
| Function | Arguments | Source description |
|---|---|---|
| _identifier | value | |
| post_init | self | |
| key | self | |
| post_init | self | |
| container_name | self | |
| volume_name | self | |
| binding_hash | self | |
| inspect | self, spec | |
| start | self, spec | |
| stop | self, spec | |
| init | self, state, backend, max_active, idle_grace_seconds, clock | |
| _locked | self | |
| _save | self, data | |
| _view | entry | |
| _spec | key, entry | |
| snapshot | self, scope | |
| begin_work | self, scope, binding, work_id, resume | |
| complete_work | self, scope, work_id, all_children_terminal | |
| stop | self, scope | |
| reap_idle | self, scope, expected_generation | |
| post_init | self | |
| init | self, config, environment_key, provision_workspace, run | |
| _command | self, args, key | |
| _json | self, args, **kwargs | |
| _key | self | |
| preflight | self | |
| check_workspace | self, spec | |
| _container | self, spec | |
| inspect | self, spec | |
| start | self, spec | |
| stop | self, spec |
harness/deploy/migration/legacy/native_api_smoke.py
| Function | Arguments | Source description |
|---|---|---|
| smoke | state, executable | |
| main |
harness/deploy/migration/legacy/native_files.py
| Function | Arguments | Source description |
|---|---|---|
| output_path | value | |
| init | self, files, company_id, owner_principal_id, root_chat_id, dataset, timeout_seconds | |
| _active | self, session, actor_chat_id | |
| publish | self, session, actor_chat_id, path, title | |
| _publish | self, session, actor_chat_id, path, title | Return metadata for the standard artifact event. Parent dispatch only. |
harness/deploy/migration/legacy/native_policy.py
| Function | Arguments | Source description |
|---|---|---|
| cli_args | config | |
| thread_params | state, instructions, tools | |
| isolated_thread_params | instructions, tools, plugins, provider_approvals | For a verified gVisor broker process only; never use on the host profile. |
| policy_digest | params | Persist permissions with tools so old permissive sessions are migrated. |
| startup_policy | executable, state, env | Remove native file tools from the installed model catalogue before launch. |
| provider_approval_policy | Native MCP approval UI only; outer worker permissions remain unchanged. |
harness/deploy/migration/legacy/native_thread_tools.py
| Function | Arguments | Source description |
|---|---|---|
| open_native_thread | connection, existing_id, known_toolset, toolset_digest, start_params, migration_export | Open current tools, or copy bounded public context into a new native thread. |
harness/deploy/native-executor/broker_service.py
| Function | Arguments | Source description |
|---|---|---|
| configure_installer | broker, directory | |
| configure_custom | broker, directory | |
| main |
harness/deploy/native-executor/relay.py
| Function | Arguments | Source description |
|---|---|---|
| copy_stream | reader, writer | |
| connection | reader, writer, socket_path | |
| main | ||
| connected | reader, writer, selected |
harness/deploy/native-executor/test_relay.py
| Function | Arguments | Source description |
|---|---|---|
| asyncSetUp | self | |
| asyncTearDown | self | |
| listen | self, handler | |
| captured | reader, writer | |
| forward | reader, writer | |
| client | self, port | |
| test_large_bidirectional_payload_and_half_close | self | |
| echo | reader, writer | |
| send | ||
| test_excess_connections_are_closed_without_waiting_queue | self | |
| wait | reader, writer | |
| test_absent_socket_returns_eof_without_destination_fallback | self | |
| forward | reader, writer |
harness/deploy/quality/prove_managed_protocol.py
| Function | Arguments | Source description |
|---|---|---|
| private_json | path, value | |
| configuration | limit, nonce, spending_mode | |
| private_bytes | path | |
| exclusive_bytes | path, data | |
| approved_time | value | |
| read_approval | args | |
| rejected_evidence | args, approval, usage | Only this definite admission rejection can reuse an unspent original hold. |
| validate_hold | usage, receipt, args, recover | |
| prepare_attempt | args, pool, usage | |
| protocol_shape | session | Small state projection: credentials, instructions and arguments stay private. |
| known | value, choices, fallback | |
| failure_details | error, stage | Retain source literals and location, never dynamic upstream error contents. |
| _check | self, response | |
| artifacts | self, session_id | |
| fetch | **params | |
| artifact_bytes | self, session_id, artifact_id | |
| wait_for_action | client, session_id, name, deadline, prior_turns, diagnostics | |
| wait_for_terminal | client, session_id, deadline | |
| cleanup | client, session_id, key | Stop known work and request sandbox deletion within a fixed 90 seconds. |
| run | args | |
| checkpoint | value, session | |
| persist_monitor | value | |
| stop | reason | |
| execute | name, arguments | |
| main |
harness/layout.py
| Function | Arguments | Source description |
|---|---|---|
| selected_vertical | vertical_id | Validate the explicit selection or the primary and legacy environment settings. |
| vertical_root | vertical_id, root | |
| code_directories | vertical_id, root | Import priority; root contains entry commands and optional deployment launchers. |
| _root_module | base, name | |
| modules | vertical_id, root | Unique flat modules and package files in this selected source tree, without imports. |
| source | module_name, vertical_id, root | Resolve a flat or package-qualified source file without loading customer code. |
| shared_asset | relative_path | A repository-relative shared asset in either checkout or repo-shaped artifact. |
| install | vertical_id | Install one vertical's paths before application imports; repeat calls are idempotent. |
harness/mechanics/access.py
| Function | Arguments | Source description |
|---|---|---|
| page_request | headers | Admit one browser page marker; the canonical header takes precedence. |
| digest | value | |
| init | self, state | |
| connect | self | |
| create_environment | self, key, name | |
| issue | self, environment, owner, now, principal_id, display_name | |
| login | self, code, now, can_query | |
| session | self, token, now | |
| switch | self, token, environment | |
| principals | self, token | |
| observe | self, token, environment_id, principal_id | |
| clear_observer | self, token | |
| logout | self, token |
harness/mechanics/agent_bridge.py
| Function | Arguments | Source description |
|---|---|---|
| system_instructions | Compose product instructions from the current vertical for each managed turn. | |
| getattr | name | |
| participant_turn | agent, chat_id | The participant whose own message started this conversation's turn, else None. |
| tool_specs | children, agent | |
| workspace_registry | agent | |
| init | self, state, retrieval, corpus, tool_only | |
| result_fields | self, name, content, success | |
| tool_result_fields | self, name, content, success | |
| _plans | self | |
| _business | self | |
| _skills | self | |
| _native_skills | self | |
| _connections | self | |
| _files | self | |
| _business_maps | self | |
| _custom_connectors | self | |
| _custom_execution | self | |
| _custom_setup | self | |
| _storage_runtime | self | |
| _publish_credential | self, chat_id, record | |
| refresh_credential_requests | self, chat_id | |
| _cancel_credential_waits | self, chat_id, reason | |
| resolve_credential_request | self, chat_id, request_id, owner, action, values, reason | |
| _wait_for_credentials | self, chat_id, connector_id, reason, scope | |
| resolve_skills | self, skill_ids, chat_id, owner_principal_id | |
| _skill_input | content, resolved | |
| _remember_usage | self, chat_id, event | |
| _is_child | self, chat_id | |
| _save_child | self, child | |
| _record_event | answer, event | |
| _complete_answer_timing | answer | |
| _remember | self, chat_id, thread_id | |
| _remember_toolset | self, thread_id, digest, opened | |
| status | self | |
| _clip_attachments | self, ids, dataset | |
| _input | self, message, attachments, clip_attachments, dataset | |
| capability_snapshot | self, chat_id, scope | |
| agent_setup_context | self, chat_id | |
| current_agent_setup | self, chat_id | |
| _approval_history_scope | self, root_chat_id, owner | |
| refresh_native_approvals | self, chat_id | |
| revoke_provider_approvals | self, provider, owner | |
| resolve_native_approval | self, chat_id, request_id, owner, action | |
| refresh_native_questions | self, chat_id | |
| _publish_question | self, chat_id, record | |
| _deliver_clarification | self, chat_id, request_id, waiter, run, response | |
| _wait_for_clarification | self, chat_id, arguments, scope | |
| deliver | native_id, response | |
| resolve_native_question | self, chat_id, request_id, owner, action, answers | |
| deliver_host | native_id, response | |
| deliver | native_id, payload | |
| active | ||
| control | self, chat_id, operation, message, attachments, clip_attachments, skill_ids, sender | |
| turn | self, message, chat_id, dataset, attachments, clip_attachments, skill_ids, model_context, sender | |
| _recorded_turn | self, message, chat_id, dataset, attachments, clip_attachments, skill_ids, model_context, sender | |
| _turn | self, message, chat_id, dataset, attachments, clip_attachments, resolved_skills, model_context | |
| _public_clip | self, record | |
| _inspection_metadata | self, record, frames, include_observations | |
| _guest | self, child, sender | This sender as a participant other than the conversation's creator, else None. |
| _authority_principal | self, chat_id | Separate the live human authority from the conversation's data owner. |
| _tool | self, name, args, scope, chat_id | |
| _scoped_tool | self, name, args, scope, chat_id | |
| _common_tool | self, name, args, scope, chat_id | |
| cover_current | ||
| current |
harness/mechanics/agent_catalogue.py
| Function | Arguments | Source description |
|---|---|---|
| available | ||
| retired | ||
| template | template_id | The template with this id, or None. |
| draft | template_id, dataset, profiles | The definition a draft agent takes from one available template, for one business collection. |
| catalogue |
harness/mechanics/agent_invocation.py
| Function | Arguments | Source description |
|---|---|---|
| invoke | agent, chat_id, arguments, now |
harness/mechanics/agent_kind_policy.py
| Function | Arguments | Source description |
|---|---|---|
| messaging_channels | agent | |
| declared_class_authority | store, definition | |
| has_participant_reach_context | agent, chat_id | An ancestor's declared restrictions survive both descendant mechanisms. |
| participant_recipient | agent, chat_id, sender | Resolve the one member a participant-reach context may message: the turn's own participant. |
harness/mechanics/agent_wakes.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, store | |
| _input_allowed | self, record, definition | |
| enqueue | self, agent_id, owner, expected_revision, provider, connection_id, event_id, kind, sender_id, channel_id, text, now, requires_input, source_scope, chain, payload | Accept an already-authenticated, owner-bound event, never new authority. |
| _get | db, key | |
| _write | db, record | |
| get | self, wake_id, owner | |
| pending | self, agent_id, owner, now | |
| _eligible | self, record, definition, now | |
| for_claim | self, db, wake_id, definition, now | |
| claimed | self, db, record, run_id | |
| _retire | self, db, record, status, reason, now | |
| cancel_pending | self, db, agent_id, reason, now | |
| get_for_run | self, db, run_id | |
| finish | self, db, run_id, status, now | |
| enqueue_chat | self, chat_id, collection, owner, actor, provider, connection_id, event_id, text, sender, chain, payload, expires_at, now, source_id | Host-bound ordinary messages enter the same chain without a saved-agent definition. |
| enqueue_job | self, producer, producer_id, owner, actor, collection, event_id, payload, source_scope, chain, destination, chat_id, kind, expires_at, now | Persist host-authorized work whose calculation may be the complete job. |
| signal_current | self, key | |
| chat_in_flight | db | A lost admitted turn holds the workspace until provider reconciliation. |
| claim_chat | self, wake_id, owner, now | |
| finish_chat | self, wake_id, claim_id, owner, status, admitted |
harness/mechanics/attachments.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, state | |
| save_attachment | self, data, name |
harness/mechanics/background_agents.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, state, input_provider, wake_authorizer, agent_classes, authority | |
| definition_model | self | |
| install_inputs | self, provider, wake_authorizer | |
| install_classes | self, declarations | |
| class_allowed | self, definition | |
| validate_class | self, definition | |
| install_authority | self, authority | |
| standing | record | |
| grant_current | self, record, now | |
| run_current | self, run, now | |
| seal_inputs | self | |
| connect | self | |
| _read | self, db, table, key | |
| _save | db, table, data | |
| _audit | db, agent_id, event, body, run_id | |
| create | self, definition, datasets, owner_principal_id, input_context, conversation_chat_id | |
| get | self, key | |
| list | self, owner_principal_id | |
| run_report | self, agent_id, run_id | |
| mark_conversation_run | self, run_id, message_start | Pin the run's report boundary before appending to its shared chat. |
| pin_skills | self, run_id, snapshots | Pin the host's resolved skill revisions once, before native execution. |
| _snapshot_report | run, messages | |
| freeze_report | self, run_id, messages | Migrate earlier terminal reports once; later chat changes cannot alter them. |
| update | self, key, definition, datasets, expected_revision, input_context | |
| activate | self, key, expires_at, once, now, expected_revision, standing, actor_principal_id | |
| active_since | self, key | When this agent's latest activation began, from its audit trail; None before the first one. |
| pause | self, key | |
| recover | self, now | Keep standing grants; reconcile admitted work before another wake. |
| input_optional_wake | self, definition, wake, admit | An adapter may admit its own signal without a fresh input batch. |
| claim | self, key, sources, now, source_records, screening, wake_id | |
| defer_unstarted_run | self, run_id | A manual turn winning the dispatch race leaves the wake and allowance pending. |
| schedule_signal | self, definition, now | |
| advance_filtered_schedule | self, signal | |
| hold | self, run_id, error | |
| resume_recovery | self, run_id | |
| execution_current | self, run_id | |
| admit_resource | self, run_id, maximum_usd | |
| finish | self, run_id, status, error, now, report_messages | |
| ensure_agent_conversation | store, agent, definition, briefing | Materialize only the host-bound chat; preserve its messages and native ID. |
| init | self, store, agent, slots | |
| ensure_conversation | self, definition, briefing | |
| recover_pending | self | |
| tick | self | |
| _finished | self, run_id, task | |
| _execute | self, run, input_snapshot | |
| pause | self, key | |
| close | self |
harness/mechanics/builtin_capabilities.py
| Function | Arguments | Source description |
|---|---|---|
| default_factory | name | |
| init | self, state, environment_id, selected, factories, spending, host_ready | |
| enabled | self, name | |
| provider | self, name | |
| pollers | self | Only explicitly installed providers contribute host polling callbacks. |
| status | self |
harness/mechanics/business_context.py
| Function | Arguments | Source description |
|---|---|---|
| public_url | value | Accept public reference URLs, never credential or private service URLs. |
| _public_text | value | |
| reference_data | self | |
| _validate | model, body | |
| _now | ||
| init | self, state, collections | |
| connect | self | |
| _collection_exists | self, collection | |
| _scope | self, db, collection | |
| _initial | self, collection | |
| _current | self, db, collection | |
| _present | self, record | |
| get | self, collection | |
| history | self, collection, limit | |
| _mutate | self, collection, expected_revision, kind, origin, change | |
| update | self, collection, expected_revision, profile, origin | |
| change | current, revision, timestamp |
harness/mechanics/business_maps.py
| Function | Arguments | Source description |
|---|---|---|
| format_guide | business | |
| _fail | ||
| _text | value, limit, empty | |
| _number | value, minimum, maximum | |
| _timestamp | value | |
| _url | value | |
| _pairs | items | |
| decode | raw | |
| validate | raw | |
| coordinate | value | |
| line | values, ring | |
| polygon | values | |
| geometry | value, allowed, empty | |
| current_member | access_path, environment, owner | Cheap host-selected membership fence; logout leaves durable ownership intact. |
| init | self, state | |
| metadata | row, stale | |
| publish | self, files, business, file_id, expected_profile_revision, owner, chat_id, collection, current, created | |
| discard | self, ids, owner, chat_id, collection | Remove only this interrupted publication's newly inserted rows. |
| get | self, business, owner, collection, map_id |
harness/mechanics/business_scope.py
| Function | Arguments | Source description |
|---|---|---|
| need | value, code | |
| identifier | value | |
| label | value, maximum, empty | |
| ids | value, maximum | |
| post_init | self | |
| init | self, state, company_id, member, members | |
| authority | self, actor, write |
harness/mechanics/capability_providers.py
| Function | Arguments | Source description |
|---|---|---|
| email_address | value | |
| body_bytes | raw | |
| json_body | raw | |
| signature_header | headers, name | |
| empty_events | ||
| message | identifier, address, text, sent_at, context, payload | |
| post_init | self | |
| init | self, config, credentials, transport | |
| credentials | self | |
| readiness | self | |
| otp_hash | self, challenge_id, code | |
| text | self, kind, text, code | |
| preview | self, kind, text, alert | |
| send | self, prepared, current | |
| before | request | |
| endpoint | self | |
| address | self, value | |
| prepare | self, kind, address, text, code, alert, reference | |
| prepare_reply | self, prepared, provider_message_id, message_id | |
| request | self, prepared | |
| identifier | self, value | |
| verify | self, raw_body, headers | |
| events | self, raw_body | |
| email_text | body | Bounded ordinary text from the provider's HTML body; scripts/styles stay out. |
| init | self | |
| handle_starttag | self, tag, attrs | |
| handle_endtag | self, tag | |
| handle_data | self, value | |
| endpoint | self | |
| prepare | self, kind, address, text, code, alert, reference | |
| units | self, prepared | |
| request | self, prepared | |
| identifier | self, value | |
| form | self, raw_body | |
| verify | self, raw_body, headers | |
| events | self, raw_body | |
| address | self, value | |
| prepare | self, kind, address, text, code, alert, reference | |
| request | self, prepared | |
| identifier | self, value | |
| verify | self, raw_body, headers | |
| events | self, raw_body | |
| provider_for | name, state, environment_id | Read one selected capability; absent host configuration installs nothing. |
| credentials |
harness/mechanics/capability_spend.py
| Function | Arguments | Source description |
|---|---|---|
| init | self | |
| init | self, state, environment_id, company_id, reader | |
| _read | self | |
| grant | self, provider, now | |
| ready | self, provider, now | |
| reserve | self, db, row, provider, prepared, now | |
| release | db, outbox |
harness/mechanics/catalogue_providers.py
| Function | Arguments | Source description |
|---|---|---|
| _fail | ||
| _digest | value | |
| _url | value, origin | |
| _entries | ||
| remote_entries | ||
| pending_policies | ||
| post_init | self | |
| from_dict | cls, value | |
| fingerprint | self | |
| policy | self | |
| post_init | self | |
| load | cls, path, company_scope, public_origin |
harness/mechanics/chat_files.py
| Function | Arguments | Source description |
|---|---|---|
| _spreadsheet_cell | value | |
| _spreadsheet_download | content, suffix, legacy | |
| init | self, state, exports | |
| connect | self | |
| _scope | owner_principal_id, chat_id, dataset | |
| create | self, document, owner_principal_id, chat_id, dataset | |
| native_name | name, title | |
| _native_preview | name, prefix, size | |
| import_native | self, stream, name, title, size_bytes, sha256, publication_key, provenance, owner_principal_id, chat_id, dataset | Host-only exact-byte import from a verified private broker buffer. |
| import_provider_resource | self, resource, provider, provider_name, publication_key, provenance, owner_principal_id, chat_id, dataset, guard, created | Host-only provider metadata and returned text; this performs no URL fetch. |
| discard_provider_publications | self, created, owner_principal_id, chat_id, dataset | Remove only this admission's new rows when its post-commit fence closes. |
| link_export | self, export_id, owner_principal_id, chat_id, dataset | |
| _export | record, chat_id | |
| list | self, owner_principal_id, chat_id, dataset | |
| _preferences | record, preferences | |
| get | self, file_id, owner_principal_id, chat_id, dataset | |
| rename | self, file_id, title, owner_principal_id | |
| opened | self, file_id, owner_principal_id | |
| content | self, file_id, owner_principal_id, chat_id, dataset | |
| download | self, file_id, owner_principal_id, chat_id, dataset |
harness/mechanics/chat_permissions.py
| Function | Arguments | Source description |
|---|---|---|
| workspace_writable | session | |
| init | self, state, organization | |
| connect | self | |
| principal | session | |
| _owned | self, record, session | |
| participant | self, record, session | The selected person reads this Tracking Agent's own conversation as one of its participants. |
| can_read | self, record, session | |
| can_write | self, record, session | Owner authority: the definition, its controls and every host interaction of the conversation. |
| can_converse | self, record, session | Write a message in the conversation: its owner, or a participant of a Tracking Agent's own chat. |
| _attachment_digest | self, attachment_id | |
| _register_attachment | self, db, attachment_id, principal, origin, authorization_note | |
| register_attachment | self, attachment_id, session | |
| can_read_attachment | self, attachment_id, session | |
| validate_attachments | self, attachment_ids, session, write | |
| _metadata | self, db, record, session | |
| get | self, record, session | |
| visible_records | self, records, session, include_archived | |
| update | self, record, session, pinned, archived, expected_revision | |
| assign_founder_history | self, records, owner_session, chat_ids, authorization_note | Host-only, explicitly authorized migration of enumerated Demo history. |
| assign_founder_attachments | self, records, owner_session, chat_ids, authorization_note | Host-only migration of images actually referenced by assigned Demo chats. |
harness/mechanics/chat_stream.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, events, capacity | |
| _publish | self, event | |
| _run | self, events | |
| subscribe | self |
harness/mechanics/company_usage.py
| Function | Arguments | Source description |
|---|---|---|
| _read_private | path | |
| _money | value | |
| _usd | value | |
| _provider_money | value | Provider reports can exceed six decimals; reserve the next micro-dollar. |
| _digest | value | |
| _openai_pricing | value | |
| init | self, state, provider | |
| openai_pool | cls, parent_state | Host-selected API pool; its funds never share the Modal trial ledger. |
| native_agent_pool | cls, parent_state | Separate host-commissioned native chat allowance; image workers never use it. |
| agent_pool_path | parent_state | |
| agent_pool | cls, parent_state | |
| _bound_openai_pool | cls, parent_state, pool_name | |
| _openai_binding | db | |
| connect | self | |
| _now | ||
| _append | self, db, key, kind, amount, reservation_id, **data | |
| _state | self, db | |
| _operator_authorization | self, db, events | Return the current immutable total allowance, including legacy funding. |
| renew_operator_budget | self, path, lifecycle, environment_id, expected_prior_record_sha256 | Host-only replacement of an expired, fully reconciled total allowance. |
| _summary | self, db | |
| summary | self | |
| reconcile_local | self | Mirror already-recorded provider evidence without querying a provider. |
| set_monthly_limit | self, expected_revision, monthly_limit_usd, retail_multiplier | |
| _fund | self, db, record_id, amount, kind, digest, **provenance | |
| import_operator_budget | self, path, lifecycle, environment_id | Host-only internal demo allocation; neither deposit nor provider credit. |
| import_funding_record | self, path | Host-only import of an actual owner-verified settled deposit receipt. |
| _provider | self, approval_path | |
| import_demo_allowance | self, approval_path, query_ledger_path | Host-only Demo setup; mirrors existing owner-authorized free credit. |
| reserve | self, maximum_usd, idempotency_key | |
| _reserve_in_transaction | self, db, provider_maximum, idempotency_key | Share the same atomic funded balance with provider-specific admissions. |
| _public_reservation | record | |
| _reservation | self, db, rid | |
| mark_started | self, reservation_id | |
| bind_openai_request | self, reservation_id, request_id, model, pricing | Pin the host's request identity and verified rate snapshot before sending. |
| settle_openai | self, reservation_id, receipt_path | Settle measured completed Responses usage from a private gateway receipt. |
| release_before_remote | self, reservation_id | |
| _provider_key | path, rid | |
| link_provider | self, reservation_id, approval_path, provider_reservation_id | |
| _apply_provider | self, db, rid, entry | |
| sync_query_reservation | self, reservation_id, query_approval_path, provider_reservation_id | |
| settle | self, reservation_id, actual_usd, source |
harness/mechanics/conversation_tools.py
| Function | Arguments | Source description |
|---|---|---|
| conversation_specs | children, definition_model | |
| init | self, definition_model | |
| specs | self, write | |
| aread | self, context, name, arguments | |
| acall | self, context, name, arguments | |
| local_call | self, context, name, arguments |
harness/mechanics/custom_connectors.py
| Function | Arguments | Source description |
|---|---|---|
| now | ||
| text | value, limit, label, optional | |
| contains_secret | value, secret | |
| init | self, state | |
| register_extension | self, name, initialize, public_values | |
| db | self | |
| identity | value | |
| _row | self, db, key, owner | |
| _public | self, db, record | |
| create | self, name, description, kind, collection, owner, chat_id | |
| get | self, key, owner | |
| list | self, owner, collection | |
| _cipher | self, db | |
| _validate_package | package | |
| save_package | self, key, package, expected_revision, owner | |
| source | self, key, owner | |
| _set_secret | self, db, key, name, value, record, package | |
| set_secret | self, key, name, value, owner | |
| _request_row | db, request_id, owner, chat_id | |
| _save_request | db, record | |
| _cancel_requests | self, db, reason, chat_id, owner, connector_id | |
| cancel_credential_requests | self, reason, chat_id, owner | |
| _check_request_current | self, db, record, owner | |
| credential_request | self, request_id, owner, chat_id | |
| credential_requests | self, owner, chat_id | |
| _public_text | self, db, key, value | |
| request_credentials | self, key, owner, chat_id, collection, reason, expires_in | |
| resolve_credential_request | self, request_id, owner, chat_id, action, values, reason | |
| remove_secret | self, key, name, owner | |
| package | self, key, owner | |
| write | name, content |
harness/mechanics/custom_coordinator.py
| Function | Arguments | Source description |
|---|---|---|
| require | value, code | |
| drain | task | Cleanup/admission remain owned through repeated caller cancellation. |
| offload | fn, *args, **kwargs | |
| _private_dir | path | |
| init | self, root | |
| close | self | |
| db | self | |
| insert_batch | self, batch | |
| pending | self, key, owner, collection | |
| request_stop | self, key, owner, collection | |
| allows_current | self, batch | |
| state | self, batch, state | |
| finish | self, batch, state, current | |
| add_job | self, batch, job | |
| jobs | self, batch | |
| job_state | self, job, state, broker, receipt, check | |
| init | self, gateway, directory | |
| start | self | |
| capture_signals | self | |
| close | self | |
| ensure_current | self | |
| current | self | |
| init | self, manager, gateway, client, root, max_batches, batch_seconds, invoke_seconds, poll_seconds, socket_factory | |
| _scope | self, batch | |
| _lock | self, key, owner, collection, wait | |
| status | self, key, owner, collection | |
| test | self, key, owner, collection, expected_revision, cancelled | |
| invoke | self, key, tool, arguments, owner, collection, cancelled | |
| _entry | self, key, owner, collection, kind, parent_cancelled, **options | |
| _watch | self, batch | |
| _begin | self, batch, options | |
| _execute | self, batch, options | |
| _job | self, batch, tool_name, arguments | |
| _cleanup_job | self, batch, job, lease, grant, listener | |
| _retire_batch | self, batch, reason | |
| _maintenance | self, operation | |
| stop | self, key, owner, collection | |
| _stop | self, key, owner, collection | |
| revoke | self, key, owner, collection | |
| _revoke | self, key, owner, collection | |
| reconcile | self, key, owner, collection | |
| _reconcile | self, key, owner, collection | |
| _reconcile_row | self, row | |
| close | self |
harness/mechanics/custom_execution.py
| Function | Arguments | Source description |
|---|---|---|
| require | value, message | |
| encoded | value | |
| digest | value | |
| exact | value, keys | |
| name | value | |
| _validation | function | |
| checked | *args, **kwargs | |
| schema | value | A bounded, fully expanded JSON-schema subset; no regex/remote resolution. |
| walk | node, depth | |
| validate_manifest | value, files | |
| authentication_fields | auth | |
| validate_target | value, declared | |
| initialize_schema | db | |
| authority | db, key | |
| retained_fields | db, key | |
| invalidate | db, key, kind | |
| public_projection | db, key | |
| public_values | db, key, readers | |
| post_init | self | |
| document | self | |
| post_init | self | |
| post_init | self | |
| metadata | self | |
| sha256 | self | |
| as_mapping | self | |
| post_init | self | |
| init | self, store, runtime, clock | |
| _owned | self, db, key, owner, collection | |
| status | self, key, owner, collection | |
| grant_target | self, key, target, owner, collection, expected_generation, expected_revision | Called only from authenticated owner target selection, never save/tools. |
| _snapshot | self, db, key, owner, collection, revision | |
| snapshot | self, key, owner, collection, expected_revision | |
| _validate | self, db, snapshot, owner, collection, draft | |
| validate_snapshot | self, snapshot, owner, collection | |
| authority_current | self, snapshot, owner, collection | |
| authority_probe | self, snapshot, owner, collection | Cheap host-only wire fence after full off-thread snapshot validation. |
| host_credentials | self, snapshot, owner, collection | Host gateway only; hold its admission fence and recheck before I/O. |
| active_snapshot | self, key, owner, collection | |
| admit_job | self, job_id, snapshot, owner, collection | Host coordinator only: persist before any broker admission/network. |
| _owned_job | self, db, job_id, owner, collection | |
| job_cleanup_state | self, job_id, owner, collection | |
| mark_job_uncertain | self, job_id, owner, collection | |
| confirm_job_cleanup | self, job_id, receipt, owner, collection | Trusted exact-job recovery; source changes never establish cleanup. |
| _cleanup_fence | db, key | |
| begin_test | self, key, owner, collection, expected_revision | |
| _test | self, db, lease, owner, collection | |
| test_snapshot | self, lease, owner, collection | |
| test_result | self, test_id, owner, collection | |
| fail_test | self, lease, owner, collection, reason | |
| confirm_test_cleanup | self, lease, receipt, owner, collection | Trusted coordinator only, after reconciling that exact broker job. |
| complete_test | self, lease, evidence, owner, collection, current | Host coordinator only, after verified worker output and actual cleanup. |
| activate | self, test_id, owner, collection, expected_active_generation | |
| revoke | self, key, owner, collection | Immediately closes new authority; caller then drains future runtime Stop. |
harness/mechanics/custom_http.py
| Function | Arguments | Source description |
|---|---|---|
| require | value, category | |
| _drain | task | |
| _offload | fn, *args | |
| _callback | fn, *args | |
| public_addresses | host | |
| validated_addresses | values | |
| _credential_echo | raw, content_type, secrets_ | |
| init | self, stream, current | |
| read | self, max_bytes, timeout | |
| write | self, buffer, timeout | |
| aclose | self | |
| start_tls | self, ssl_context, server_hostname, timeout | |
| get_extra_info | self, info | |
| init | self, host, addresses, current, backend | |
| connect_tcp | self, host, port, timeout, local_address, socket_options | |
| connect_unix_socket | self, *args, **kwargs | |
| sleep | self, seconds | |
| document | self | |
| init | self, company_id, max_calls, per_job_calls, request_seconds, resolver, network_backend, ssl_context, clock | |
| issue | self, snapshot, tool, validate, credentials, current, cancelled, ttl_seconds | |
| _issue | self, snapshot, tool, validate, credentials, current, cancelled, ttl_seconds | |
| _alive | self, job | |
| _job | self, token | |
| _request | self, job, document | |
| _headers | self, job, values | |
| value | field | |
| request | self, token, document | |
| _execute | self, job, operation, url | |
| observations | self, grant_id | Host-only journal; caller binds grant ID to its admitted worker/test. |
| revoke | self, grant_id | |
| close | self | |
| call | self, scope, receive, send |
harness/mechanics/custom_routes.py
| Function | Arguments | Source description |
|---|---|---|
| body | request, fields | |
| register_custom_routes | app, identity, owner_for_connector | |
| selected | request, key, write | |
| execution | connector_id, request | |
| target | connector_id, request | |
| activate | connector_id, request | |
| test | connector_id, request | |
| revoke | connector_id, request | |
| stop | connector_id, request |
harness/mechanics/custom_runtime.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, store, client, coordinator_factory | |
| _initialize | self | |
| ready | self | |
| test | self, *args, **kwargs | |
| invoke | self, *args, **kwargs | |
| status | self, *args, **kwargs | |
| stop | self, *args, **kwargs | |
| revoke | self, *args, **kwargs | |
| close | self |
harness/mechanics/custom_setup.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, manager | |
| propose | self, key, target, reason, expected_revision, owner, collection | |
| approve | self, key, proposal_id, owner, collection | |
| describe | self, key, owner, collection |
harness/mechanics/custom_tool_contracts.py
| Function | Arguments | Source description |
|---|---|---|
| object_schema | properties, required | |
| execution_schema | ||
| target_schema | ||
| tool_specs |
harness/mechanics/custom_worker.py
| Function | Arguments | Source description |
|---|---|---|
| need | value | |
| canonical | value | |
| digest | value | |
| path_parts | value | |
| request | value | |
| bundle | value, expected, company, owner, image, worker_sha256 | |
| read_regular | path, limit | |
| run | source, config, workspace, execute |
harness/mechanics/delegated_jobs.py
| Function | Arguments | Source description |
|---|---|---|
| specs | write | |
| role_plan | agent, chat_id | |
| role | self | |
| current | self | |
| configuration | self, tools | |
| init | self, state | |
| claim | self, context, role, task, call | |
| save | self, job | |
| children | self, binding_id | |
| execute | self, context, role, task, call | |
| result | job, child | |
| _run | self, context, job, child, grant | |
| acall | context, name, arguments | |
| withdraw_children | runtime, agent, parent_binding | Cancellation uses original saved IDs and needs no renewed tool authority. |
harness/mechanics/document_preview_contract.py
| Function | Arguments | Source description |
|---|---|---|
| post_init | self | |
| parse | cls, value | |
| validate_manifest | manifest, files, request, original_sha256, original_bytes | |
| require | condition |
harness/mechanics/document_preview_readiness.py
| Function | Arguments | Source description |
|---|---|---|
| root_bytes | path, uid | |
| init | self, enabled, receipt_sha256, receipt_path, reader | |
| ready | self |
harness/mechanics/document_preview_routes.py
| Function | Arguments | Source description |
|---|---|---|
| deny | status, code | |
| identity | request, write | |
| empty_body | request | |
| register_document_preview_routes | app, previews_for_workspace, owner_for_file | |
| selected | request, file_id, write | |
| metadata | file_id, request | |
| prepare | file_id, request | |
| disconnected | ||
| page | file_id, page, request |
harness/mechanics/document_preview_worker.py
| Function | Arguments | Source description |
|---|---|---|
| regular | path, maximum | |
| checksum | path | |
| tree_bytes | root | |
| run | argv, work, limits, deadline, capture | |
| check_ooxml | path, format | |
| png_dimensions | path | |
| prepare | file_id, format, source, output, limits | |
| main |
harness/mechanics/document_previews.py
| Function | Arguments | Source description |
|---|---|---|
| require | value, code | |
| digest | raw | |
| canonical | value | |
| offload | function, *args, **kwargs | |
| init | self, files, client, enabled, cache_bytes | |
| db | self, write | |
| original | self, file_id, owner | |
| row | self, key | |
| _status | self, key, status | |
| content | self, file_id, owner | |
| _body | self, key, name | |
| page | self, file_id, page, owner | |
| lock | self, key | |
| _begin | self, key, record, owner, generation | |
| _save | self, key, record, owner, manifest, contents | |
| prepare | self, file_id, owner | |
| cleanup |
harness/mechanics/document_rendering.py
| Function | Arguments | Source description |
|---|---|---|
| render | suffix, title, content | |
| _inline | tokens | |
| _blocks | content | |
| _docx | title, content | |
| add_runs | paragraph, runs | |
| _pdf | title, content | |
| text | runs | |
| footer | canvas, document | |
| _xlsx | title, content | |
| _worker |
harness/mechanics/harness_routes.py
| Function | Arguments | Source description |
|---|---|---|
| shell | selected, session, collection, guards | The active template's shell with the reader's fixed conversation ids for one collection. |
| register_harness_routes | app | |
| harness | request, collection |
harness/mechanics/harness_tools.py
| Function | Arguments | Source description |
|---|---|---|
| _listed | names | |
| source_reference | name | Repository documentation references follow the selected source layout. |
| capability_rows | template | The table for one template: its own rows first, then the harness rows with the sentences it adds. |
| capability_problems | template | What keeps a vertical's rows from joining the table, as sentences. Empty means the table is whole. |
| capabilities | template | The table as rows an agent reads: id, title, state and the three statements that hold words. |
| capability_table | template | The table as README.md prints it: the rows of the default vertical, one markdown row each with its files. |
| write_readme | path | Put the table into the front door, in place of the one it holds. |
| developer_prompt | template | The paragraph that tells an agent what it is part of and that get_harness answers the rest. |
| specs | write | |
| read | context, name, args | |
| call | context, name, args | |
| registry | agent | Report the selected workspace registry used by its live tool transports. |
| serve | context, name, arguments | |
| _tools | live | |
| _problems | template, live | What the manifest names and the running service lacks, as sentences. Empty means they agree. |
| _layers | template | |
| _built_with | template | |
| _fixed_conversations | template | |
| _agents | context, kind, default | The reader's own agents of one class in this collection, where the surface holds the agent store. |
| _agent_classes | context, template | |
| _ready_agents | template | |
| _channels | context, template | |
| _tile_sets | template | |
| _vocabulary | template | |
| _skills | context, template, live | The skills of the company where the surface holds its stores; the vertical's seeds everywhere. |
| _count | result | How many rows a listing read returned, by the name of each list it holds. |
| _connected | context, source, live | Whether the company has rows in one data source today, from the reads the registry serves. |
| _data_sources | context, template, live | |
| describe | context, section, template | The answer of get_harness for one reader: context is the ReadContext the registry hands a read. |
| main | arguments |
harness/mechanics/intake_instructions.py
| Function | Arguments | Source description |
|---|---|---|
| getattr | name | |
| for_chat | agent, chat_id, base | Attach only host-authenticated purpose instructions, including on resume. |
harness/mechanics/local_workspace.py
| Function | Arguments | Source description |
|---|---|---|
| local_services | state, principal_id, dataset, derivatives_enabled | |
| local_authority | self, actor, collection | |
| read_admission | self, actor, collection |
harness/mechanics/managed_connections.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, store, scope, relay, run, current | |
| deliver | self, item, guard | |
| request | self, server, tool, arguments, identity | |
| init | self, agent, chat_id, run, relay | |
| current | self | |
| execute | self, provider, tool, arguments, identity | |
| close | self | |
| write_connection | agent, chat_id, arguments |
harness/mechanics/managed_mcp.py
| Function | Arguments | Source description |
|---|---|---|
| _identity | value | |
| _private_file | path, create | |
| id | self | |
| current | self | |
| close | self | |
| admit | self, grant | |
| init | self, host, row, services | |
| session_id | self | |
| tools | self | Send this only in the provider credential field, never a chat or receipt. |
| record_current | self | |
| created | self, provider_session_id | Bind the API-issued session once; a conflicting response cannot adopt it. |
| begin | self, actor, admission, cancel, deadline, current_run, quiesced, run, request_id, recovering | Host-only: quiesced certifies reconciled root and inherited children. |
| current | self | |
| end | self, generation, disconnected | Withdraw immediately; closing an old generation cannot stop its successor. |
| revoke | self, generation | |
| _pending_reads | self | |
| drain | self | Retain captured snapshots while the transport drains actual worker reads. |
| init | self, state, public_origin, clock, monotonic | |
| _initialize | self | |
| _db | self | |
| _require_epoch | self, db | |
| _row | self, binding_id | |
| _token | self, key | |
| bind_session | self, binding_id, company_id, data_owner, root_chat, collection, services | |
| revoke_binding | self, binding_id | Withdraw a saved session even when restart has no live generation. |
| _current_generation | self, generation | |
| authenticate | self, token | |
| active | self, key | |
| resolve | self, grant | |
| lifespan | self |
harness/mechanics/managed_sessions.py
| Function | Arguments | Source description |
|---|---|---|
| identity | value | |
| encoded | value | |
| digest | value | |
| new_key | ||
| init | self, state | |
| _private_file | self, create | |
| transaction | self | |
| _migrate | self | |
| fingerprint | configuration, capabilities | |
| _binding_record | row | |
| _insert | self, db, values, configuration, capabilities, generation | |
| binding | self, company_id, chat_id, owner, collection, configuration, capabilities | |
| rollover | self, company_id, chat_id, owner, collection, configuration, previous_id, quiesced, capabilities | |
| retire | self, binding_id, reason | |
| retired | self, binding_id | |
| for_owner | self, company_id, owner | |
| generations | self, company_id, chat_id | |
| artifact | self, binding_id, artifact_id, metadata, file_id | |
| request_binding | self, company_id, chat_id, logical_id | |
| pending_binding | self, company_id, chat_id | |
| get | self, binding_id | |
| created | self, binding_id, session_id | |
| submission | self, binding_id, logical_id, kind, payload | |
| claim | self, binding_id, action, generation, actor_chat, write, recoverable | |
| completed | self, binding_id, call_id, generation, receipt | |
| save_delivery_boundary | self, binding_id, request_id, call_id, delivery | Stop recovery at the original durable send, even after a lost result reply. |
| delivery_boundary | self, binding_id, request_id | |
| turn | self, binding_id, turn, actor_chat | |
| turns | self, binding_id | |
| _request_record | row | |
| request | self, binding_id, logical_id, input_value | A pending outbox keeps exact input until its provider turn is terminal. |
| request_record | self, binding_id, logical_id | Read one original input without admitting or changing it. |
| pending | self, binding_id | |
| for_chat | self, company_id, chat_id | |
| request_state | self, request_id, status, baseline, turn_id |
harness/mechanics/managed_usage.py
| Function | Arguments | Source description |
|---|---|---|
| identity | value | |
| init | self, pool | |
| _request | self, db, request_id | |
| request | self, request_id | |
| monitor | self, request_id, initial | Persist the original target/deadline beside its existing funding hold. |
| save_monitor | self, request_id, receipt | |
| capacity | self, binding_id, session_id | |
| reserve | self, **arguments | |
| _reserve | self, db, binding_id, request_id, actor, model, limit_cents, session_id, recovering | |
| role_plan | self, parent_request | |
| reserve_parent | self, roles, **arguments | |
| activate_role | self, parent_request, role_id, ordinal, binding_id, request_id, actor, model, limit_cents, session_id, recovering | |
| release_unused_roles | self, parent_request | |
| created | self, binding_id, session_id | |
| finish | self, request_id, snapshot, terminal_status | |
| settle_closed | self, binding_id, receipt_path | Operator-only, provider-final reconciliation; estimates cannot call this. |
harness/mechanics/mcp_access.py
| Function | Arguments | Source description |
|---|---|---|
| public | self | |
| init | self, state, clock | |
| _db | self | |
| _scope | company_id, owner_principal_id, dataset | |
| _row | row | |
| issue | self, company_id, owner_principal_id, dataset, label, ttl_seconds | Host-only: authenticate and authorize the requested scope before calling. |
| list | self, company_id, owner_principal_id | |
| get | self, key, company_id, owner_principal_id | |
| revoke | self, key, company_id, owner_principal_id | |
| authenticate | self, token | |
| active | self, key |
harness/mechanics/mcp_connections.py
| Function | Arguments | Source description |
|---|---|---|
| _now | ||
| _hash | value | |
| _identity | value | |
| _binding | value | |
| _provider | value | |
| validate_provider_url | url, hosts | |
| filter | self, record | |
| init | self, stream | |
| aiter | self | |
| aclose | self | |
| init | self, hosts | |
| handle_async_request | self, request | |
| public | value | |
| aclose | self | |
| init | self, broker, principal, provider, generation | |
| get_tokens | self | |
| set_tokens | self, tokens | |
| get_client_info | self | |
| set_client_info | self, client_info | |
| init | self, requested_scopes, token_auth_method, allow_authorization, refresh_token_endpoint, registered_policy, current, *args, **kwargs | |
| _initialize | self | |
| _refresh_token | self | |
| _clamp | self | |
| _perform_authorization_code_grant | self | |
| _auth_flow | self, request | |
| post_init | self | |
| init | self, token, endpoint, current | |
| auth_flow | self, request | |
| init | self, state, public_origin, flow_timeout, write_providers, registered_clients, remote_providers | |
| _revoke_configuration | db, provider | |
| _provider | self, provider | |
| provider_policy | self, provider | Host-only defensive copy; request data cannot modify broker authority. |
| provider_policies | self | |
| _client | self, provider | |
| _configured | self, provider | |
| _configuration_current | self, db, provider | |
| provider_available | self, provider | Host-only configured authority, distinct from customer consent. |
| provider_policy_revision | self, provider | |
| _db | self | |
| write_providers | self | |
| recover | self | |
| _record | self, provider, principal | |
| _check | self, provider, principal, generation, connected | |
| _update | self, provider, principal, generation, **changes | |
| _begin | self, provider, principal, access_mode | |
| _invalidate | self, provider, principal, generation | |
| _flow_state | self, flow, status | |
| catalogue | self, principal_id | |
| read_generation | self, provider, principal_id | Host-only connection identity, excluding OAuth material. |
| capabilities | self, principal_id | Host-only capability summary from the last successful tool discovery. |
| start | self, provider, principal_id, session_binding, access_mode | |
| connect_bearer | self, provider, credential, principal_id, session_binding, access_mode | |
| _start | self, provider, principal_id, session_binding, access_mode, credential | |
| _connect | self, flow | |
| _failed | self, flow, status | |
| _redirect | self, flow, url | |
| flow_status | self, flow_id, principal_id, session_binding | |
| oauth_callback | self, state, code, principal_id, session_binding, error | |
| _session | self, provider, principal, generation, flow | |
| redirect | url | |
| callback | ||
| _listed | self, session, provider | |
| review | value, depth | |
| _scope_fence | self, provider, principal | |
| admission | self, provider, principal_id, expected_generation | Host-only dispatch fence; no OAuth, effects, retry, or approval claim. |
| dispatch_admission | self, provider, principal_id, expected_generation | Shared provider capacity plus the current-account dispatch fence. |
| dispatch_credentials | self, provider, principal_id, expected_generation, minimum_validity_seconds | Fixed credential snapshot only inside admission; never starts OAuth. |
| _operation | self, provider, principal, expected_generation | |
| public_error | error | |
| tools | self, provider, principal_id, expected_generation | |
| _write_enabled | self, provider, config, row | |
| execution_binding | self, provider, tool, principal_id, expected_generation | |
| _redact_credentials | self, value, provider, principal, generation | |
| call | self, provider, tool, arguments, principal_id, expected_generation | |
| deny_schema_io | uri | |
| _cancel_flows | self, provider, principal | |
| disconnect | self, provider, principal_id | |
| finish | ||
| close | self |
harness/mechanics/mcp_host.py
| Function | Arguments | Source description |
|---|---|---|
| _read | function, *args, **kwargs | Retain the transport's admission until a cancelled host read finishes. |
| init | self, state, access, services_for_environment, public_origin | |
| _environment | self, company_id, principal | |
| resolve | self, grant | |
| register_routes | self, app | |
| actor | request, writable | |
| connections | request | |
| create_connection | request | |
| revoke_connection | key, request |
harness/mechanics/mcp_server.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, services, principal, collection | |
| visible_names | self | |
| list_tools | self | |
| call_tool | self, name, arguments | |
| _read | self, name, arguments | |
| make_server | state, principal_id, dataset, derivatives_enabled, services |
harness/mechanics/messaging.py
| Function | Arguments | Source description |
|---|---|---|
| require | value, message | |
| post_init | self | |
| upgrade | db | Bring an existing store to SCHEMA_VERSION inside the caller's transaction. |
| columns | table | |
| init | self, state, company_id, provider, adapters, authorized, clock, spend, send_admission, channel_names, capability_spend | |
| _install | self, adapter, replace | One adapter per channel, for this company, each with its own sender account. |
| provider | self | The WhatsApp adapter, the first built transport. |
| provider | self, value | |
| adapter | self, channel | |
| channels | self | Selected channels, each with its adapter and spending readiness. |
| member_channels | self, db, member | This member's verified addresses on the current sender accounts, by channel. |
| eligible | self, db, member | (channel, address generation) in channel order: verified, opted in, on a commissioned channel. |
| _default_channel | self, member | The channel a send uses when its caller names none: channel order, then the built transport. |
| return_replies | self, db, member, chat | Unadmitted replies of a member who left a Tracking Agent's participants continue their setup chat. |
| _spend_open | self, channel | The host's Stop and an unreadable spend record hold every provider-bound send of the company. |
| host_actor | self, member, collection, chat | The member themself in one conversation, for host work addressed to them. |
| _auth | self, actor, self_only | |
| _db | self, write, before_commit | |
| connect | ||
| _ready | self, kind, channel | |
| _account | self, channel | |
| _contact | self, db, member, channel | |
| _public_contact | row | |
| _public_challenge | row | |
| _public_outbox | row | |
| describe | self, actor | |
| _run | self, operation, cancelled | |
| watch | ||
| _current | self, actor, outbox_id, stop | |
| _settle | self, identifier, status, provider_id | |
| _capability_admission | self, actor, row, prepared, stop | |
| fence | ||
| _dispatch | self, actor, row, prepared, stop, still | |
| current | ||
| send_prepared | self, actor, row, prepared, still, cancelled | One provider request for a host delivery whose outbox row its claim already wrote. |
| operation | stop | |
| _replay | self, db, actor, request_id, intent | |
| _insert | self, db, actor, identifier, channel, address, kind, text, request_id, intent, generation | |
| request_code | self, actor, phone, request_id, channel, cancelled | Send a security code over the channel it proves. phone is that channel's address. |
| operation | stop | |
| prepare | ||
| read | ||
| verify_code | self, actor, challenge_id, code | Confirm a security code. The challenge carries its channel. |
| revoke | self, actor, channel | Explicit authenticated contact removal, for one channel or all; accepted sends still drain. |
| bind_conversation | self, actor, channel | |
| send_hello | self, actor, request_id, channel, cancelled | |
| send_message | self, actor, text, request_id, channel, cancelled | |
| send_alert | self, actor, alert, request_id, channel, cancelled | |
| _send | self, actor, kind, text, request_id, cancelled, channel | |
| operation | stop | |
| prepare | ||
| _reply_target | self, db, provider, contact, reply_to, now, reply_kind | Which conversation a reply continues, by the channel's own rule (CHANNELS.md). |
| handle_webhook | self, raw_body, signature, channel | Admit one signed provider request. signature is the header value or the request headers. |
| _reply | self, row | |
| _admissible | self, db, row | A reply is admitted for a current member, on their current address, into a chat that takes them. |
| pending_replies | self, limit | |
| signal_reply_current | self, event_id, signal | Recheck the exact verified provider event at each signal admission. |
| unsettled_replies | self, limit | Receipts needing reconciliation only; they never authorize new work. |
| claim_reply | self, event_id | |
| finish_reply | self, event_id, claim_id, admitted | |
| recover | self | Call after prior workers drain. Uncertain work is never replayed. |
| close | self |
harness/mechanics/messaging_composition.py
| Function | Arguments | Source description |
|---|---|---|
| compose_messaging | capabilities, authorized, clock, spend, send_admission, capability_spend | |
| callback_response | channel | Use only after signature verification and durable ingress acknowledgement. |
harness/mechanics/messaging_config.py
| Function | Arguments | Source description |
|---|---|---|
| _fail | ||
| _absolute_path | value | |
| _read | path | |
| _template | value, category | |
| provider_for | state, environment_id | Build the provider for the selected workspace, or leave other environments alone. |
| credentials | ||
| spend_for | state, environment_id | The reader of the host's spend record for participant phone chat. |
| read |
harness/mechanics/messaging_provider.py
| Function | Arguments | Source description |
|---|---|---|
| e164 | value | |
| digest | value | |
| bounded | value, maximum | |
| post_init | self | |
| post_init | self | |
| post_init | self | |
| new | cls, identifier, message_id | |
| readiness | self | |
| otp_hash | self, challenge_id, code | Hash a security code under a secret only the host holds. |
| address | self, value | Validate one recipient address for this channel; E.164 for sms and whatsapp. |
| prepare | self, kind, address, text, code, alert, reference | kind is 'otp', 'hello', 'text' or 'utility'; reference is the outbox ID. |
| prepare_reply | self, prepared, provider_message_id, message_id | Attach a previously admitted incoming message when the channel supports threads. |
| preview | self, kind, text, alert | The text the member reads, saved with the outbox row. |
| units | self, prepared | Billable units, read ahead of the send. |
| send | self, prepared, current | One provider request. Calls current immediately before it leaves and sends only on True. |
| verify | self, raw_body, headers | Raise ProviderError on an invalid signature, ahead of any parsing. |
| events | self, raw_body | |
| init | self, config, credentials, transport | |
| company_id | self | |
| account_id | self | |
| commissioned | self | |
| credentials | self | |
| readiness | self | |
| otp_hash | self, challenge_id, code | |
| prepare | self, kind, address, text, code, alert, reference | |
| preview | self, kind, text, alert | |
| utility_message | self, alert | |
| send | self, prepared, current | |
| before | request | |
| verify_subscription | self, mode, token, challenge | |
| verify | self, raw_body, headers | Meta signs the raw body with the app secret; nothing is parsed before this passes. |
| webhook | self, raw, signature | The Meta payload of one verified request: its messages and its statuses. |
| events | self, raw_body | Meta's messages and statuses in the neutral shape. WhatsApp sends no opt-out or subscription here. |
| _parse | self, raw |
harness/mechanics/messaging_signals.py
| Function | Arguments | Source description |
|---|---|---|
| reserve_send | store, actor, row | One stable outgoing effect unit in the same workspace-wide signal ledger. |
| init | self, messaging, store, agent, member, answered | |
| current | self, signal | |
| _admitted | self, reply | |
| _queued | self, reply, owner, connection | |
| tick | self | |
| _finish | self, reply, admitted |
harness/mechanics/native_custom_broker.py
| Function | Arguments | Source description |
|---|---|---|
| drain | task | |
| silent_command | timeout, *argv | Untrusted container console is discarded; all retained output has quota. |
| init | self, broker, worker_path, backend | |
| live_count | self | |
| _row | self, key | |
| _status | self, key, status, result | |
| _socket_dir | self, key | |
| _lease | self, row | |
| _validate | self, scope, lease | |
| _public | self, row | |
| prepare | self, scope, request_id, document | |
| upload | self, scope, lease, reader, writer | |
| _freeze_socket | self, key | |
| start | self, scope, lease, capability | |
| _run | self, key | |
| _freeze_output | self, key, request | |
| _finish | self, key, succeeded | |
| stop | self, scope, lease | |
| _discard | self, key | |
| release | self, scope, lease | |
| read | self, scope, lease, writer | |
| reconcile | self | |
| expire | self | |
| handle | self, operation, scope, request, reader, writer | |
| init | self, root, script | |
| volume_key | key | |
| name | key | |
| volume_path | self, key | |
| run | self, key, root, sockets | |
| stop | self, key | |
| present | ||
| unmount | self, key |
harness/mechanics/native_custom_client.py
| Function | Arguments | Source description |
|---|---|---|
| post_init | self | |
| request_for | snapshot, tool, arguments | |
| init | self, socket_path | |
| _connect | self, operation, scope, **values | |
| _request | self, operation, scope, **values | |
| capabilities | self, scope | |
| prepare | self, scope, request_id, snapshot, tool, arguments | |
| recover | self, scope, request_id, retire | |
| status | self, scope, lease | |
| stop | self, scope, lease | |
| release | self, scope, lease | |
| start | self, scope, lease, gateway_token | |
| upload | self, scope, lease, snapshot, tool, arguments | |
| result | self, scope, lease, snapshot, tool, arguments |
harness/mechanics/organization_chats.py
| Function | Arguments | Source description |
|---|---|---|
| getattr | name | |
| init | self, state, environment_id, member, records | |
| _hash | *parts | |
| _collection | collection | |
| identity | self, collection, purpose | |
| canonical | self, record | |
| owns | self, record | |
| can_read | self, record, session | |
| ensure | self, agent, collection, purpose | |
| setup_identity | self, member, collection | |
| member_setup | self, agent, member, collection |
harness/mechanics/phone_chat.py
| Function | Arguments | Source description |
|---|---|---|
| card_text | status, title, name, channel | The chat entry of a contact card says what its state is. |
| init | self, message, status | |
| _identity | value, maximum | |
| chat_admits | db, chat, member | A participant-reach agent's chat takes messages from its current participants. |
| resolve_member | db, member, now, eligible | Resolve one member's bindings against their current verified addresses. |
| init | self, messaging, agents, member, post, clock | |
| _saved | self, agent_id | |
| _member | self, member_id | |
| _caller | self, by | |
| _manager | self, policy, by, company_owner | |
| _expected | policy, expected_generation | |
| _ensure | self, db, record, now | The default at promotion: policy on, the creator, their enabled binding, their card. |
| _admit | self, db, record, member, role, by, now, requested_by | |
| _request | self, db, record, member, requested_by, now | |
| _expire | db, now | |
| _revoke | self, db, agent, member, now | End one participant's phone reach. Their unadmitted replies return to their own setup chat. |
| _refresh | self, db, record, now | Apply what changed outside this store: verified addresses, opt-outs and expiry. |
| _bump | db, agent, by, now | |
| _participant | db, agent, member | |
| public_request | row | |
| _snapshot | self, db, record | |
| _result | self, record | |
| state | self, agent_id | Read one participant-reach agent's phone records, creating the default ones on first read. |
| add_participant | self, agent_id, member_id, by, company_owner, expected_generation | |
| remove_participant | self, agent_id, member_id, by, company_owner, expected_generation | |
| update_binding | self, agent_id, member_id, by, enabled, channel, expected_generation, company_owner | |
| set_delivery | self, agent_id, state, by, company_owner, expected_generation | |
| request_contact | self, agent_id, member_id, by, company_owner | Raise the contact card in the agent's chat, or return the open one. |
| recipient | self, agent_id, chat_id, member_id, channel, host | The gate's answer: the one member this participant-reach agent's turn may message. |
| participant_chat | self, chat_id, member_id | True when this chat is a participant-reach agent's and the member is one of its current participants. |
| publish | self, agent_id, member_id | Mirror each contact card's state into its chat entry, outside the store's transaction. |
harness/mechanics/phone_delivery.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, reason | |
| delivery_id | company_id, agent_id, member_id, alert_id, alert_revision | The same ID after a retry, a restart, a duplicate outbox claim and a channel fallback. |
| clean | value, limit | One line of plain text within its limit. |
| alert_lead | title, revision | The agent's title; a later revision names the alert it updates. |
| alert_text | title, summary, revision | The agent's title and the alert's summary in at most 600 characters. |
| alert_link | origin, chat_id, alert_id | One link into Rocoto. It opens the alert after the member's ordinary sign-in and carries no token. |
| mask | address | An E.164 number keeps its first four characters and last two digits; another address its last four. |
| public | row | |
| _update | db, row, now, **changes | |
| settle | db, outbox, status, provider_id, now, returned | The provider's answer to one attempt sets the delivery's status. |
| stopped | db, row | The agent's policy is paused, or this participant switched their alerts off or left. |
| receipt | db, outbox, status, now | A provider receipt moves a delivery forward in the built order sent, failed, delivered, read. |
| restart | db, now | A restart moves every dispatching delivery to uncertain; it is reconciled before any retry. |
| cancel_queued | db, agent, now, member | Stop reaches the queued deliveries of one agent, or of one of its participants. |
| window_lane | ingestion, event | The lane of the stream window that carried a committed tracker event. |
| alert_lane | ingestion, event | The lane a committed tracker event arrived in: 'live', 'replay' or 'unknown'. |
| init | self, messaging, phone, origin, post, concurrency | |
| lane | self, alert_id, decide | The lane of one observation, decided once and kept: 'live', 'replay' or 'unknown'. |
| _prune | db, now | Remove what retention has released: deliveries, their outbox rows, then receipts and lanes. |
| prune | self, force | One retention pass, at most once a minute. Returns the deliveries removed. |
| history_full | self | True while retained history is at its bound, so a new alert writes nothing. |
| unread | self, agent_id, alert_ids, alert_revision | The alerts of this list that hold no fan-out receipt and no kept replay lane, for the catch-up pass. |
| fan_out | self, agent_id, alert_id, summary, alert_revision, lane, committed_at, since | Write one delivery per participant whose binding is enabled, and return the ones written. |
| full | ||
| _entry | self, db, alert | |
| sync_entries | self, limit | Append each alert to its chat in arrival order, then keep its delivery states current. |
| _current | self, db, row, now | The agent is a Tracking Agent with its policy on; the member is a current participant with alerts on. |
| _prepare | self, provider, contact, alert, row, reference, now | The provider request for one channel, or the reason this channel holds the alert. |
| _claim | self, identifier | Repeat the admission checks, reserve the units and mark one queued delivery dispatching. |
| close | status, reason | |
| _still | self, identifier, outbox_id | The admission checks again, immediately before the provider call. |
| _deliver | self, identifier | |
| _sweep | self, limit | Expire what stayed unsent for 900 seconds and list the queued deliveries, oldest first. |
| tick | self, limit | One pass of the worker: expire, claim and dispatch, then bring the chat entries up to date. |
| drain | self | Wait for the sends in flight, then record their states in the chat entries. |
| close | self | Stop the sends still in flight. A finished send needs nothing more. |
| reconcile | self, identifier, outcome, reviewed_by | Record the host's review of an uncertain send. It is reconciled before any retry. |
| deliveries | self, agent_id, alert_id | |
| answered | self, reply | The alert a participant's phone reply answers, as host-supplied context for the turn it starts. |
| block | self, agent_id, reader, company_owner, writable, members, admitted | The phone block of CHANNELS.md for one reader: a current participant or the company owner. |
| main | argv | The host operator's entry point for an uncertain send. |
harness/mechanics/phone_routes.py
| Function | Arguments | Source description |
|---|---|---|
| register_phone_routes | app, member, members | member(selected, principal) answers a current owner or operator; members(selected) lists them. |
| reader | request, agent_id | The caller as a current company member, and this Tracking Agent's chat within their scope. |
| covered | ||
| block | request, selected, agent_id, principal, owner, admitted | |
| body | request, shape, required | A JSON object of the named fields, each of its declared type, in at most 8192 bytes. |
| change | request, agent_id, shape, required, operation | Authorize the caller, apply one change as that caller and answer with the fresh block. |
| phone_block | agent_id, request | |
| phone_add | agent_id, request | |
| phone_remove | agent_id, member_id, request | |
| phone_participant | agent_id, member_id, request | |
| phone_delivery_state | agent_id, request | |
| phone_contact_request | agent_id, request |
harness/mechanics/phone_spend.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, reason | |
| record | reader | The host's spend record, validated. Anything else is unreadable. |
| admit | reader | The host's answer ahead of any provider-bound phone send of the company. |
| day | now | |
| resets_at | now | The next UTC midnight. |
| _used | db, today, scope | |
| reserve | db, reader, agent, units, now, outbox | Add one message's units to the agent's and the company's counters for the current UTC day. |
| release | db, outbox | Return the units of a send that provably stayed inside Rocoto. Sent, failed and uncertain keep theirs. |
| usage | db, reader, agent, now | The phone block's spend object: units used today against each cap, and the state they give. |
harness/mechanics/private_records.py
| Function | Arguments | Source description |
|---|---|---|
| read_private | path, code_root |
harness/mechanics/profile_activity.py
| Function | Arguments | Source description |
|---|---|---|
| reader | path | |
| _agent_pool_path | state | |
| bind_model_run | state, run_id, owner | Host-only forward attribution before dispatch; the model supplies neither ID. |
| _attribution | state, owner | |
| stamp | value | Known persisted seconds or explicitly zoned ISO timestamps, normalized UTC. |
| access_scope | access_path, session, scope | Fresh membership for the selected host company, including owner observation. |
| member | principal | |
| _json | value | |
| _sum | rows | |
| activity | state, scope, principal_id, identity, organisation_allowed, chats, days, now | |
| owned | row | |
| day | value |
harness/mechanics/profile_cover_generation.py
| Function | Arguments | Source description |
|---|---|---|
| canonical | value | |
| digest | value | |
| brief | profile, member, target, direction | |
| init | self, state, api_key, pool, transport | |
| connect | self | |
| _review | self, value | |
| _emit | self, emit, event | |
| _discard_file | files, publication_key, file_id, scope | |
| generate | self, scope, store, files, business, member, target, expected_profile_revision, direction, current, emit | |
| check | ||
| prepare | ||
| admit | ||
| start | ||
| receive | ||
| publish | ||
| cleanup |
harness/mechanics/profile_cover_host.py
| Function | Arguments | Source description |
|---|---|---|
| tool_specs | ||
| init | self, selected, access, transport | |
| member | self, actor_id | |
| authorize | self, actor_id, target, target_id, collection, write | |
| business | self, actor_id, collection, data | |
| members | self, actor_id, collection, rows | |
| tool | self, name, args, owner, actor_id, chat_id, collection, turn_id, current, emit | |
| guard | ||
| install_profile_covers | selected, access, transport | |
| register_routes | app | |
| context | request, cover_id |
harness/mechanics/profile_cover_routes.py
| Function | Arguments | Source description |
|---|---|---|
| register_profile_cover_routes | app, context_for_request | context_for_request(request, cover_id) -> (store, actor_id, collection). |
| cover | cover_id, request |
harness/mechanics/profile_covers.py
| Function | Arguments | Source description |
|---|---|---|
| image_bytes | raw | Decode bounded raster bytes, orient them, and strip embedded metadata. |
| init | self, state, authorize | |
| connect | self | |
| _access | self, actor_id, target, target_id, collection, write | |
| metadata | row | |
| publish | self, files, business, file_id, target, owner, actor_id, chat_id, collection, current, created, expected_profile_revision | |
| get | self, actor_id, target, target_id, collection | |
| download | self, cover_id, actor_id, collection | |
| discard | self, ids, owner, chat_id, collection | Host cleanup for newly published artifacts in an interrupted turn. |
harness/mechanics/profile_image_usage.py
| Function | Arguments | Source description |
|---|---|---|
| measured_usage | value | |
| actual_cost | usage | |
| bind | pool, reservation_id, request_id | |
| settle | pool, reservation_id, receipt_path |
harness/mechanics/provider_configuration.py
| Function | Arguments | Source description |
|---|---|---|
| commissioned_writes_for | requested, registered_clients, remote_providers | Apply a host's write selection to this company's available provider policies. |
| _company_configuration | state, public_origin, environment, loader | |
| registered_clients_for | state, public_origin | |
| remote_providers_for | state, public_origin |
harness/mechanics/provider_credentials.py
| Function | Arguments | Source description |
|---|---|---|
| private_file | fd | |
| directory | state | |
| locked | root, exclusive | |
| init | self, root, company | |
| key | self, create | |
| binding | self, principal, provider, generation, field | |
| seal | self, value, principal, provider, generation, field | |
| open | self, value, principal, provider, generation, field | |
| _bounded_database | path, legacy | |
| configure_database | db | SQLite's pager limit belongs to this connection, not to the DB file. |
| _tables | db | |
| _format | db, company | |
| initialize | root, company | Fast fresh initialization; historical migration is an explicit host operation. |
| migrate_connections | state | Explicit, synchronous migration; stop all old/new users of this DB first. |
harness/mechanics/provider_outputs.py
| Function | Arguments | Source description |
|---|---|---|
| canonical | value | |
| digest | value | |
| label | value, fallback, limit | |
| external_url | value | Only navigable public HTTPS links; no host/network resolution is performed. |
| _google_created_file | result | Drive create_file's documented File result, not arbitrary JSON URLs. |
| resources | result, provider, tool | Standard MCP blocks plus the reviewed, host-bound Drive create_file shape. |
| init | self, files, relay, owner, root_chat_id, dataset, company_id, current | |
| event | self, method, params, actor_chat_id | |
| guard |
harness/mechanics/provider_policy.py
| Function | Arguments | Source description |
|---|---|---|
| selected_scopes | config, mode | |
| scopes | value | |
| provider_read_only | config, row | |
| read_authorized | config, row, name | |
| visible_tools | config, row, inventory | |
| digest | value | |
| effective_policies | remote_providers | Host configuration projection shared by broker and deployment filtering. |
harness/mechanics/public_mcp.py
| Function | Arguments | Source description |
|---|---|---|
| getattr | name | |
| registry | self | |
| admit | self, grant | |
| _public | value, depth | |
| init | self, services | |
| call | self, grant, name, args, scope_guards | |
| invoke | ||
| init | self, store, resolve_scope, resource_url, call_timeout, recheck_seconds, max_sessions, max_calls, max_calls_per_key, idle_timeout, resource_path, permission | |
| listing | ||
| call | name, arguments | |
| _resolve | self, grant | |
| _authorization | self, lookup, value | |
| resolve | ||
| finished | task | |
| verify_token | self, token | |
| _current | self, key | |
| _request_scope | self | |
| error | ||
| _call | self, name, args | |
| changed | ||
| drain | ||
| _read | self, grant, services, name, args | |
| _endpoint | self, scope, receive, send | |
| replay | ||
| scope_current | ||
| binding_current | ||
| guarded | message | |
| call | self, scope, receive, send | |
| lifespan | self |
harness/mechanics/public_urls.py
| Function | Arguments | Source description |
|---|---|---|
| require | value | |
| validate_url | value |
harness/mechanics/recipe_runs.py
| Function | Arguments | Source description |
|---|---|---|
| specs | write | |
| init | self, state | |
| connect | self | |
| scope | context | |
| _get | self, db, context, run_id | |
| get | self, context, run_id | |
| list | self, context | |
| begin | self, context, recipe | |
| update | self, context, run_id, expected_revision, step_id, status, note, evidence | |
| _store | context | |
| read | context, name, arguments | |
| call | context, name, arguments |
harness/mechanics/registered_oauth.py
| Function | Arguments | Source description |
|---|---|---|
| _fail | ||
| _object | pairs | |
| _callback | origin | |
| read_private_configuration | path, max_bytes | |
| post_init | self | |
| fingerprint | self | |
| policy_fingerprint | self | |
| client_info | self, requested_scopes | |
| post_init | self | |
| get | self, provider | |
| load | cls, path, company_scope, public_origin | Read one bounded private file; token/grant fields are rejected. |
harness/mechanics/scope_host.py
| Function | Arguments | Source description |
|---|---|---|
| current_admission | ||
| bind_admission | admission | |
| setup_scope | selected, member, members | |
| scope_current | value | |
| conversation_root | agent, record | Resolve saved descendants through a bounded, same-owner ancestry chain. |
| history_allowed | selected, record, principal | |
| turn_actor | agent, chat_id, sender | |
| _conversation_authority | agent, chat_id, dataset, sender | |
| current | ||
| agent_scope | agent, chat_id, dataset, sender, admit | |
| empty | ||
| active_scope_current | agent, chat_id | |
| filter_view | selected, view, principal, collection, chat_id, observer | |
| _owned_views | selected, principal, collection | |
| history_within_view | selected, record, view |
harness/mechanics/signal_chain.py
| Function | Arguments | Source description |
|---|---|---|
| bounded | value | |
| init | self, store | |
| recover | self, db | |
| reserve | self, db, kind, reservation, target, amount, target_limit, now | |
| release_unstarted | self, db, reservation | |
| usage | self, now | |
| validate_payload | payload | |
| validate_chain | chain | |
| register | self, name, handler, kind, timeout_seconds, cleanup_seconds, cancel, reconcile, metered, config_schema, description | Install a host adapter, including its cleanup and reconciliation contract. |
| declarations | self | |
| reviewed_chain | self, chain | Person-facing chain selection uses explicit host declarations only. |
| register_producer | self, name, authorized | |
| _rules | step, payload | |
| matches | clause | |
| producer_current | self, record | |
| _current | self, record | |
| _context | self, record, receipt, cancelled | |
| external | identity | |
| _output | output, payload | |
| _invoke | self, registered, payload, config, context, receipt | |
| cleanup | ||
| process | self, signal | Advance one saved chain; immutable ingress remains its authority evidence. |
| _chain_status | self, record, receipt | |
| reconcile | self, signal_id, owner | |
| _save_step | self, receipt | |
| receipts | self, signal_id, owner |
harness/mechanics/signal_dispatcher.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, store, agent, scheduler, slots, sources | |
| tick | self | |
| _finished | self, task | |
| _execute | self, signal | |
| recover_pending | self | |
| close | self |
harness/mechanics/signal_endpoints.py
| Function | Arguments | Source description |
|---|---|---|
| target_url | value | |
| canonical | value | |
| digest | value | |
| init | self, store, authorized, owner_authorized, resolver, network_backend, ssl_context | |
| public | record | |
| _write | db, record | |
| get | self, key | |
| current | self, record | |
| register | self, context, label, url, daily_sends | |
| list | self, actor, chat_id | |
| reveal | self, key, actor, chat_id | |
| revoke | self, key, actor, chat_id | |
| _producer_current | self, signal | |
| send | self, context, endpoint_id, event, payload, call_identity | |
| _send | self, payload, config, context | |
| current |
harness/mechanics/signal_screening.py
| Function | Arguments | Source description |
|---|---|---|
| canonical | value | |
| private_json | path, value | |
| init | self, store, pool, api_key, transport, clock | |
| _prerequisites | self | |
| request | payload, config | |
| run | self, payload, config, context | |
| _finish | self, admission | |
| reconcile | self, context |
harness/mechanics/signal_sources.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, store, public_origin, environment | |
| _write | db, record | |
| _get | db, key | |
| get | self, key | |
| current | self, record, now | |
| _create | self, kind, owner, actor, chat_id, collection, label, chain, authority_until, now, **fields | |
| create_hook | self, days, signature, authority_until, **identity | |
| set_timer | self, note, delay_seconds, every_seconds, fires, authority_until, **identity | |
| public | self, record | |
| list | self, actor, chat_id, collection | |
| reveal | self, key, actor, chat_id | |
| cancel | self, key, actor, chat_id | |
| _deliver | self, record, event_id, text, payload, now | |
| receive | self, key, raw, signature, event_id, now | |
| tick | self, now |
harness/mechanics/skills.py
| Function | Arguments | Source description |
|---|---|---|
| getattr | name | |
| _json | value | |
| _hash | value | |
| _text | value, maximum | |
| _names | value, pattern, maximum | |
| _connections | value | |
| _definition | body, previous | |
| _revision | value | |
| _seeds | template | A template's skill seeds as this store saves them: (id, definition), each through _definition. |
| init | self, state | |
| connect | self | |
| _append | db, skill_id, revision, fields, origin, publisher | |
| _read | row | |
| _current | self, db, skill_id | |
| _installed | db, skill_id | |
| _decorate | self, db, record | |
| catalogue | self | |
| list | self | |
| install | self, skill_id, expected_revision | |
| create | self, body, origin | |
| update | self, skill_id, expected_revision, body, origin | |
| history | self, skill_id | |
| resolve | self, ids, capabilities, available_tools, max_count | Snapshot installed instructions using capabilities supplied by trusted host code. |
harness/mechanics/source_icons.py
| Function | Arguments | Source description |
|---|---|---|
| normalized_host | host | |
| raster_icon | body | |
| init | self, resolver, network_backend, ssl_context, clock | |
| get | self, host | |
| _fetch | self, url |
harness/mechanics/source_media.py
| Function | Arguments | Source description |
|---|---|---|
| _require | condition, code | |
| _identifier | value, pattern | |
| _number | value | |
| _json | value | |
| post_init | self | |
| key | self | |
| post_init | self | |
| post_init | self | |
| parse | cls, value | |
| manifest_request | self, scope, collection, checksum | |
| wall_seconds | self | |
| image | self | |
| arguments | self | |
| name | self | |
| original | self | |
| output | self | |
| init | self, root | |
| volume_path | self, key, generation | |
| mount | self, spec | |
| flags | self, spec | |
| start | self, spec | |
| wait | self, spec | |
| stop | self, spec | |
| present | ||
| unmount | self, spec | |
| _directory | path | |
| _identity | info | |
| _copy_original | fd, destination, uid, size, checksum | |
| _read_json | path, limit | |
| _validate_manifest | manifest, files, scope, collection, size, checksum, sealed | |
| _validate_derived_manifest | manifest, files, scope, collection, size, checksum, request | Validate fixed-profile claims and sealed byte hashes without media decoding. |
| dimensions | row | |
| source_frame | frame | |
| _snapshot | spec, scope, size, checksum, worker_uid | Copy ordinary files only after the whole worker is confirmed absent. |
| _drain | task | Finish an owned bounded operation even after repeated cancellation. |
| init | self, root, backend, app_uid, app_gid, clock, worker_uid, document_previews | |
| _row | self, key | |
| _derivation_body | self, row | |
| _spec | self, row | |
| _valid | self, scope, lease | |
| _update | self, key, status, confirmed, error, result | |
| submit | self, scope, generation, collection, original_sha256, original_bytes, expires_at, original_fd | |
| derive | self, scope, generation, collection, original_sha256, original_bytes, expires_at, original_fd, derivation | |
| preview | self, scope, document, **values | |
| _submit | self, scope, generation, collection, original_sha256, original_bytes, expires_at, original_fd, derivation | |
| _expiry | self, expires | |
| heartbeat | self, scope, lease, expires_at | |
| _run | self, scope, row, spec | |
| enforce_expiry | ||
| cleanup | ||
| status | self, scope, lease | |
| stop | self, scope, lease | |
| _reconcile | self, row | |
| recover_lease | self, scope, generation | |
| recover | self | |
| output_file | self, scope, lease, index | |
| release | self, scope, lease | |
| close | self | |
| _send_packet | sock, payload | |
| _receive_packet | sock | |
| _send_json | sock, value | |
| _receive_json | sock | |
| _receive_request | sock, app_uid | |
| init | self, broker, path | |
| start | self | |
| _accept | self | |
| _connection | self, sock | |
| close | self | |
| init | self, socket_path, server_uid | |
| _connect | self, operation, scope, lease, original_fd, **values | |
| _exchange | self, operation, scope, lease, **values | |
| _request | self, operation, scope, lease, **values | |
| submit | self, scope, **values | |
| derive | self, scope, **values | |
| preview | self, scope, **values | |
| _admit | self, operation, scope, **values | |
| exchange | ||
| recover | self, scope, generation | |
| status | self, scope, lease | |
| heartbeat | self, scope, lease, expires_at | |
| stop | self, scope, lease | |
| release | self, scope, lease | |
| read_output | self, scope, lease, index | |
| _main | args |
harness/mechanics/stored_media.py
| Function | Arguments | Source description |
|---|---|---|
| media_format | name, prefix | |
| media_response | raw, media_type, range_header |
harness/mechanics/title_stream.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, previous | |
| valid | text | |
| feed | self, event |
harness/mechanics/transfer_budget.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, code, message | |
| init | self, period | |
| init | self, path, daily_cap, monthly_cap | |
| _periods | now | |
| _blank | self | |
| _lock | self | |
| _read_locked | self | |
| _write_locked | self, value | |
| initialize | self | Create the ledger once, or validate an existing ledger without resetting it. |
| reserve | self, byte_count, now, path, method | Atomically reserve a response's declared bytes before its headers send. |
| status | self, now | |
| _headers | message | |
| init | self, app, budget | |
| _eligible | cls, path, headers | |
| _deny | send, status, code | |
| call | self, scope, receive, send | |
| guarded_send | message |
harness/mechanics/wake_tools.py
| Function | Arguments | Source description |
|---|---|---|
| specs | write | |
| _sources | context | |
| read | context, name, arguments | |
| call | context, name, arguments | |
| _endpoints | context | |
| acall | context, name, arguments |
harness/mechanics/web_mount.py
| Function | Arguments | Source description |
|---|---|---|
| base_path | value | |
| init | self, app, prefix, orders_origin, company, read_only, public_origin | |
| path | self, path | |
| origin | self, scope | |
| text | self, text, origin | |
| attribute | match | |
| value | self, value, origin | |
| unvalue | self, value, origin | |
| headers | self, headers, path | |
| call | self, scope, receive, send | |
| normalized_receive | ||
| wrapped | message | |
| proxy | self, scope, receive, send, path | |
| refuse | send, status |
harness/mechanics/workspace_capabilities.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, connections, custom_connectors, custom_execution, inputs, contribution, builtins | |
| live_input_ready | collection | |
| execution | self, definition | |
| snapshot | self, collection, principal, chat_id, read_only, child, actor |
harness/mechanics/workspace_identity.py
| Function | Arguments | Source description |
|---|---|---|
| _private_regular | descriptor | |
| _locked | state | |
| _read | path | |
| _write | state, record | |
| workspace_identity | state | Adopt once at the original location; retain that identity after migration. |
| workspace_scope | state | |
| onboarding_identity | state, collection | |
| initialize_new_workspace | state | Host-only fresh-company creation; copied history must retain its identity. |
harness/run.py
| Function | Arguments | Source description |
|---|---|---|
| main | argv |
harness/runtime/agent_auth.py
| Function | Arguments | Source description |
|---|---|---|
| _hosted | origin, host | |
| cli_args | self | |
| init | self, state, public_origin, mode, environ, runtime_host | |
| _environment | self | |
| status | self | |
| launch | self | |
| verify_api_credentials | self, timeout, transport | Read current model access; this does not execute or prove inference. |
| lease | self, run_id, gateway_factory, unix_socket, activity_owner | Historical adapter fixture lease; managed execution uses ManagedPolicy.turn. |
harness/runtime/api_smoke.py
| Function | Arguments | Source description |
|---|---|---|
| smoke | state, api_key | |
| main |
harness/runtime/hosted_capabilities.py
| Function | Arguments | Source description |
|---|---|---|
| _hash | data | |
| _name | value | |
| _zip | name, files, directories | |
| _read_file | package, entry | Read verified files through held directory FDs, including every ancestor. |
| _manifest | files, public_servers | |
| current | self | |
| commands | self, resolved | |
| init | self, state, store, public_read_servers | |
| _cache_directory | self | |
| _archive | self, sha, data | |
| freeze | self, configuration | Save provider configuration with private archive references, not blobs. |
| configuration | self, frozen | |
| _packages | selection | |
| _guard | self, principal, identity | |
| prepare | self, principal_id, resolved_skills | |
| _upload | name, description, data | |
| restore | self, principal_id, identity, frozen |
harness/runtime/hosted_install.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, transport | |
| acquire | self, entry, catalogue |
harness/runtime/managed_children.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, agent, chat_id, run, session, client, admission | |
| require_current | self | |
| refresh | self | Only a bounded, fully paginated provider response establishes lineage. |
| ancestry | self, child_id | |
| admit | self, child_id | |
| public_event | self, chat_id | |
| recover_history | self | A subagent's separate canonical history repairs missed live events. |
harness/runtime/managed_codex.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, code, status_code, request_id | |
| _identity | value | |
| _submission | value | |
| _obj | value | |
| type | self | |
| event_id | self | |
| session_id | self | |
| turn_id | self | |
| item_id | self | |
| subagent_id | self | |
| root_turn_outcome | self | |
| category | self | |
| init | self, api_key, transport, timeout, max_event_bytes, spending_mode | |
| aenter | self | |
| aexit | self, *exc | |
| aclose | self | |
| _check | response | |
| _request | self, method, path, body, params, submission_key | |
| _session_path | session_id | |
| _page_params | after, limit, order | |
| list_artifacts | self, session_id, after, limit, order | |
| get_artifact | self, session_id, artifact_id | |
| artifact_content | self, session_id, artifact_id, max_bytes | Read bounded immutable bytes from the fixed provider origin, without redirects. |
| create_session | self, config, submission_key | Create a bounded session using OpenAI-managed execution. |
| _spend_control | value | |
| update_session | self, session_id, config, submission_key | Update subsequent turns while preserving a finite session allowance. |
| delete_session | self, session_id, submission_key | Delete a caller-owned session and request its hosted sandbox cleanup. |
| get_session | self, session_id | |
| list_sessions | self, after, limit, order | |
| get_turn | self, session_id, turn_id | |
| list_turns | self, session_id, after, limit, order | |
| list_subagent_turns | self, session_id, subagent_id, after, limit, order | Inspect child turns separately; an active child may be idle. |
| list_items | self, session_id, subagent_id, after, limit, order | |
| list_subagents | self, session_id, after, limit, order | |
| submit_events | self, session_id, events, submission_key | Send native message/cancel/tool-result/approval schemas unchanged. |
| send_message | self, session_id, text, submission_key, images | |
| steer | self, session_id, text, submission_key | Native message input steers an active turn, or starts an idle turn. |
| interrupt | self, session_id, submission_key | Request cancellation; await native terminal events to confirm its result. |
| open_events | self, session_id | Subscribe before sending. EOF is a disconnect, not a successful turn. |
| _decode_events | self, response | |
| _collect | self, fetch, max_pages | |
| collect_items | self, session_id, subagent_id, max_pages | |
| fetch | **params | |
| recover_session | self, session_id, max_pages, max_buffered_events | Open+buffer SSE, then retrieve canonical state, without resubmitting work. |
| pump | ||
| buffered_events | ||
| fetch_turns | **params |
harness/runtime/managed_diagnostics.py
| Function | Arguments | Source description |
|---|---|---|
| _details | error, phase | |
| record_failure | state, chat_id, error, phase | Keep the latest private failure per hashed chat; failures here preserve UI. |
harness/runtime/managed_files.py
| Function | Arguments | Source description |
|---|---|---|
| resource_id | value | |
| metadata | value | |
| init | self, agent, ledger, client, current | |
| require_current | self, binding | |
| completed_turn | self, binding, session, artifact | |
| harvest | self, binding |
harness/runtime/managed_policy.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, authority, usage, binding_id | |
| created | self, session_id | |
| current | self | |
| init | self, configuration, mcp, generation, usage, request_id, steering, binding_id | |
| created | self, session_id | |
| revoke | self, disconnected | |
| persist_monitor | self, receipt | |
| finish | self, snapshot, terminal_status | |
| init | self, turn_limit_cents, spending_mode | |
| _require | agent, chat_id, run, admission | |
| base_configuration | self, agent, chat_id, tools, instructions | |
| _monitor | self, usage, request_id, run, target, model, recovering, baseline | |
| _role_turn | self, agent, chat_id, session_id, request_id, binding_id, admission, run, recovering | |
| turn | self, agent, chat_id, tools, instructions, session_id, request_id, binding_id, admission, run, recovering, steering | |
| _provider_limit | snapshot, session_id, usage, binding_id, allowance, roles |
harness/runtime/managed_runtime.py
| Function | Arguments | Source description |
|---|---|---|
| resolved | value | |
| function_tools | registry | Delegation belongs to OpenAI's stock coordinator tools. |
| portable_content | content, state | |
| pages | fetch, limit | |
| quiescent | client, session_id | An available subagent may be idle; its saved turns decide quiescence. |
| init | self, client_factory, policy, timeout | |
| _require | agent, chat_id, run, admission | |
| _input | self, agent, message, chat_id, dataset, attachments, clips, skills, model_context, selected | |
| _history | input_value, record, current_user | |
| _revoke_binding | agent, binding | |
| _cancel | self, run | A local cancellation flag alone never confirms upstream cancellation. |
| control | self, agent, chat_id, operation, message, attachments, clip_attachments, skill_ids, sender | |
| _update | client, engine, configuration, key | |
| _observe | self, client, engine, created, input_value, submission_key, baseline | |
| _project | self, observer, run | Publish host prompts while a provider function awaits their answer. |
| _stop_monitor | run | |
| _harvest_files | self, agent, client, chat_id, current, answer, binding_id | |
| recover_files | self, agent, chat_id | Read retained generations without sending input or reserving new funds. |
| run | self, agent, message, chat_id, dataset, attachments, clip_attachments, resolved_skills, model_context, instructions, recovering, recovery_answer, delegated_grant | |
| execute | name, arguments | |
| monitored_stop | reason | |
| files_current | ||
| cleanup | ||
| recover | self, agent, chat_id | Recover current access, or withdraw already-funded work after access ends. |
| _recover_admitted | self, agent, chat_id | Resume the exact pending outbox into its original saved assistant row. |
| recover_request | self, agent, chat_id, logical_id | Resolve one saved scheduler input without creating another provider turn. |
| revoke_plugin | self, agent, principal_id, plugin_id | Retire every original session carrying a removed package, including idle ones. |
| recover_pending | self, agent | Workspace startup can resume admitted requests without new input/funding. |
| configured_runtime | agent | Use the owning workspace's protected OpenAI credential and funded policy. |
| client |
harness/runtime/managed_spend.py
| Function | Arguments | Source description |
|---|---|---|
| spending_mode | value | |
| estimate_cents | snapshot, model | Conservative token estimate; missing optional usage stays unknown. |
| init | self, target_cents, deadline_at, model, baseline, observed_cents | |
| from_receipt | cls, receipt | |
| receipt | self | |
| observe | self, snapshot | |
| watch | self, client, session_id, cancel, persist, poll_interval | Poll until cancellation is requested; caller owns root/child Stop proof. |
harness/runtime/managed_turn.py
| Function | Arguments | Source description |
|---|---|---|
| current_managed_call | Host-only identity of the ledger-admitted function being executed now. | |
| hosted_connection_pending | session, action | OpenAI connects its hosted environment; the host only waits for readiness. |
| init | self, client, ledger, binding, run, admission, registry, execute, result_fields, current, request, children | |
| require_current | self | |
| accept_session | self, session | |
| attributed_turn | self, turn_id | |
| required_actions | self | History items and client arguments never authorize effect execution. |
| event | self, event | Whitelist public fields; provider errors/configuration remain private. |
| snapshot | self, session, items, turns, turn_ids | Reconcile canonical public history before consuming buffered events. |
| child_output | self, turn, event |
harness/runtime/native_approvals.py
| Function | Arguments | Source description |
|---|---|---|
| identity | value | |
| canonical | value | |
| digest | value | |
| native_key | value | |
| stamp | value | |
| arguments | value | |
| post_init | self | |
| post_init | self | |
| permitted | self | |
| init | self, state, clock | |
| _db | self | |
| _public | row | |
| _row | db, request_id, scope | |
| _change | self, db, row, status, reason, **changes | |
| _fresh | self, db, row, scope, binding, cancelled, refusing | |
| open | self, scope, actor_chat_id, native_request_id, turn_id, call_id, binding, tool_arguments, ttl_seconds | |
| get | self, request_id, scope | |
| interrupt | self, request_id, scope, reason | Retire one owned saved request after its live root connection is gone. |
| for_chat | self, scope | |
| delivery_guard | self, request_id, scope, binding, cancelled | Synchronous predicate executed under the native connection write lock. |
| answer | self, request_id, scope, binding, action, deliver, cancelled | |
| resolve_native | self, scope, native_request_id | |
| invalidate | self, scope, provider, company_id, owner, reason | Host Stop/disconnect/reconfiguration hook; dispatched writes stay uncertain. |
| provider_cancellations | self, scope, provider | Private outstanding reply IDs, including a prior durable invalidation. |
| preflight_failed | self, request_id, scope | Close failed host preflight; return a private reply ID only if unanswered. |
| cancel_guard | self, request_id, scope, cancelled | Close one still-unanswered native request under its transport lock. |
| finish_call | self, scope, thread_id, turn_id, call_id | |
| expire | self, scope | Return private native reply IDs alongside public records for one host run. |
| recover | self | |
| claim_dispatch | self, scope, binding, metadata, tool_arguments, cancelled | Host-only future transport hook. No caller in this increment sends writes. |
| provider_has_unresolved | self, scope, provider, metadata | Host admission across this owner's chats; exact-call replay is exempt. |
| outcome | self, request_id, scope, status, receipt | Host reconciliation only; never infer remote success from native completion. |
| init | self, store, scope, resolve_binding, cancelled, write | |
| _deny | self, native_id | |
| event | self, item, actor_chat_id | |
| answer | self, request_id, owner, action | |
| deliver | native_id, payload, guard | |
| retire | self, reason | |
| revoke_provider | self, provider | Close this run's provider waits after host connection revocation begins. |
| expire | self |
harness/runtime/native_events.py
| Function | Arguments | Source description |
|---|---|---|
| _text | value, limit | |
| _output | value | |
| _arguments | value | Native arguments are public, but a malformed/huge value need not fill chat. |
| _question_record | params, request_id | |
| context_usage | token_usage | |
| plan_usage | response | Keep native plan windows; exclude account IDs and opaque credit currencies. |
| init | self, result_fields | |
| _message | self, identity, text | |
| translate_many | self, method, params, request_id, verified_children | Expand a native item without deriving product authority from its IDs. |
| translate | self, method, params, request_id |
harness/runtime/native_executor.py
| Function | Arguments | Source description |
|---|---|---|
| post_init | self | |
| key | self | |
| post_init | self | |
| name | self | |
| _command | timeout, input, *argv | |
| init | self, root, size_bytes | |
| mount | self, key | |
| unmount | self, volume | |
| init | self, volumes | |
| mount | self, key | |
| volume_path | self, key | |
| unmount | self, volume | |
| inspect | self, spec | |
| flags | spec | |
| start | self, spec, capability | |
| pause | self, spec | |
| unpause | self, spec | |
| stop | self, spec | |
| _path_parts | value | |
| _checked_directory | parent, name, uid | |
| snapshot_outputs | workspace, destination, uid, paths | Snapshot owned ordinary files without following a mutable path or symlink. |
| copy_file | parent, name, relative | |
| walk | parent, prefix, depth | |
| init | self, root, run_root, backend, app_uid, app_gid, clock, socket_owner, socket_group | |
| live_count | self | |
| _row | self, key | |
| _spec | self, row | |
| _update | self, key, status, volume | |
| _validate | self, scope, lease | |
| prepare | self, scope | |
| _freeze_sockets | self, spec | |
| install_packages | self, scope, lease, reader, writer | Reserve the lease before accepting a bounded stream; no host paths. |
| start | self, scope, lease, capability | |
| _stop_row | self, row | |
| stop | self, scope, lease | Caller revokes model/MCP grants first; removal kills the whole process tree. |
| reconcile | self | |
| expire_prepared | self | |
| snapshot | self, scope, lease, paths | |
| output_file | self, scope, lease, snapshot_id, index | |
| _read_package_frame | reader, limit | |
| _read_frame | reader | |
| _write_frame | writer, kind, body | |
| init | self, broker, path | |
| start | self | |
| expire | ||
| close | self | |
| _connection | self, reader, writer | |
| _fields | value, allowed | |
| _reply | writer, value | |
| _relay | process, reader, writer | |
| stdin | ||
| output | source, kind | |
| init | self, writer | |
| write | self, data | |
| drain | self | |
| write_eof | self | |
| close | self | |
| init | self, client, scope, lease, reader, writer | |
| _pump | self | |
| wait | self | |
| stop | self | |
| init | self, socket_path | |
| _connect | self, operation, scope, lease, **values | |
| _request | self, operation, scope, lease, **values | |
| prepare | self, scope | |
| install_packages | self, scope, lease, selection | |
| start | self, scope, lease, gateway_capability | |
| stop | self, scope, lease | |
| snapshot | self, scope, lease, paths | |
| read_output | self, scope, lease, snapshot_id, index |
harness/runtime/native_install_broker.py
| Function | Arguments | Source description |
|---|---|---|
| drain | task | |
| init | self, broker, allowed_sources, worker_path, backend | |
| live_count | self | |
| _row | self, identifier | |
| _status | self, key, status, result | |
| _lease | self, row | |
| _validate | self, scope, lease | |
| _public | self, row | |
| prepare | self, scope, request_id, document | |
| upload | self, scope, lease, reader, writer | |
| _run | self, key | |
| _finish | self, key, successful | |
| _freeze | self, key, document | |
| stop | self, scope, lease | |
| release | self, scope, lease | |
| _discard | self, key | |
| reconcile | self | |
| expire | self | |
| read | self, scope, lease, writer | |
| handle | self, operation, scope, request, reader, writer | |
| init | self, root, script | |
| volume_key | key | |
| name | key | |
| volume_path | self, key | |
| run | self, key, incoming | |
| stop | self, key | |
| present | ||
| unmount | self, key |
harness/runtime/native_install_client.py
| Function | Arguments | Source description |
|---|---|---|
| drain | task | |
| init | self, socket_path | |
| _connect | self, operation, scope, **values | |
| _request | self, operation, scope, **values | |
| capabilities | self, scope | |
| prepare | self, scope, request_id, document | |
| request | self, operation, scope, lease | |
| upload | self, scope, lease, path, document | |
| read | self, scope, lease, destination, document | |
| init | self, state, client, fetch | |
| acquire_for_principal | self, entry, catalogue, principal_id | |
| cleanup |
harness/runtime/native_install_readiness.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, state, enabled, client | |
| probe | self, store, principal_id |
harness/runtime/native_install_source.py
| Function | Arguments | Source description |
|---|---|---|
| url | self | |
| archive_root | self | |
| document | self | |
| source_spec | entry, catalogue | |
| fetch_archive | spec, destination, transport | One finite public HTTPS attempt; caller retries a fresh request explicitly. |
harness/runtime/native_install_worker.py
| Function | Arguments | Source description |
|---|---|---|
| canonical | value | |
| sha | value | |
| request | value | |
| parts | value | |
| verify_archive | path, expected | |
| extract_selected | archive, expected, destination | Stream selected subtree only, rejecting links/devices and ambiguous names. |
| tree_inventory | root | |
| materialize | archive, document, workspace, execute | |
| run | arguments |
harness/runtime/native_mcp.py
| Function | Arguments | Source description |
|---|---|---|
| getattr | name | |
| post_init | self | |
| _error | message | |
| init | self, agent, scope, company_id, clock, call_timeout, provider_relay | |
| list_tools | ||
| call_tool | name, arguments | |
| _lineage | self, chat_id, thread_id | |
| issue | self, actor_chat_id, actor_thread_id, ttl_seconds | Host-only grant creation; default is the inherited read-only root grant. |
| issue_provider | self, server_name, ttl_seconds | Host-only: bind an original server to its package or direct policy. |
| provider_configs | self | Private native config writes; credentials remain in the host broker. |
| _provider_read | self, binding, operation | |
| invoke | ||
| drain | ||
| _participant_reach_context | self, binding | |
| _provider_write | self, binding, name, arguments, metadata | |
| drain | ||
| _valid | self, binding | |
| revoke | self, grant_id | |
| revoke_all | self | |
| _call | self, binding, name, arguments, metadata | |
| invoke | ||
| _result | parts | |
| lifespan | self | |
| call | self, scope, receive, send | |
| _http_error | send, status |
harness/runtime/native_package_mount.py
| Function | Arguments | Source description |
|---|---|---|
| encoded | value | |
| digest | value | |
| parts | value | |
| validate_metadata | value, company, owner | |
| selection_metadata | selection | |
| _read_json | path | |
| native_config | root, metadata | Enable original skills; explicitly disable every bundled MCP server. |
| seal | root | |
| ensure_mount_target | volume | Never follow model-created links when preparing Docker's nested target. |
| open_source | root, relative | Held descriptor chain prevents app-owned source symlinks from redirecting. |
| toml_value | value | Codex -c expects TOML values; JSON object colons are not TOML assignments. |
harness/runtime/native_packages.py
| Function | Arguments | Source description |
|---|---|---|
| _read_packages | function, *args, **kwargs | Hash bounded package trees off-loop while retaining the caller's fence. |
| _json | value | |
| _hash | value | |
| _principal | value | |
| _name | value | |
| _ordinary_directory | path, create | |
| _fsync_dir | path | |
| _identity | info | |
| _scan_tree_unchecked | root, destination | Walk held directory FDs and hash/copy exact regular files without following links. |
| visit | fd, relative, depth | |
| _scan_tree | root, destination | |
| _remove_private_tree | path | |
| init | self, executable, timeout | |
| _base | self | |
| _environment | home | |
| _stop | process | |
| _drain_cleanup | task | |
| _command | self, args, home, cwd | |
| discard | stream | |
| cleanup | process | |
| read | stream, limit | |
| _source | self, entry, snapshot, market | |
| acquire | self, entry, snapshot | |
| init | self, state, catalogue_snapshot, materializer | |
| _db | self | |
| _lock | self | |
| _entry | self, identifier | |
| _rows | self, owner | |
| _public | body | |
| list | self, principal_id | |
| read | self, identifier, principal_id | |
| _verified | self, body | |
| _reconcile_trees | self | |
| install | self, identifier, principal_id | |
| uninstall | self, identifier, principal_id | |
| snapshot | self, principal_id, plugin_ids | |
| runtime_selection | self, principal_id | Prevent install/removal racing a bounded native worker start. |
| validate_runtime_snapshot | self, selection, principal_id | Recheck the selected package bytes inside the held runtime lock. |
| validate_snapshot | self, selection, principal_id |
harness/runtime/native_plugins.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, process | |
| call | self, method, params | |
| init | self, state, api_key, executable, snapshot, session_factory | |
| _paths | self, principal_id | |
| _manifest | self | |
| _session | self, principal_id | |
| _entry | self, identifier | |
| _status | row | |
| _list | self, session, marketplace | |
| list | self, principal_id | |
| read | self, identifier, principal_id | |
| install | self, identifier, principal_id | |
| uninstall | self, identifier, principal_id | |
| set_enabled | self, identifier, enabled, principal_id |
harness/runtime/native_provider_relay.py
| Function | Arguments | Source description |
|---|---|---|
| _read | function, *args, **kwargs | |
| _canonical_policy | value | |
| init | self, store, connections, selection, company_id, principal_id | |
| server_names | self | |
| providers | self | |
| _direct_identity | self, provider | |
| _direct_current | self, route | |
| display_name | self, server_name | |
| _current | self, name, expected | |
| grant | self, server_name | |
| valid | self, grant | |
| tools | self, grant | |
| call | self, grant, name, arguments, metadata, cancelled, alive | |
| configure_writes | self, approvals, scope, enabled, timeout | Host commissioning seam; selecting read_write alone does not enable it. |
| operation_kind | self, grant, name | |
| prepare_write | self, server, name | |
| approval_binding | self, server, name | |
| _authority_admission | self, server_name | |
| write_admission | self, binding | |
| write_credentials | self, binding | |
| write_recheck | self, binding | |
| prompt_policy | self, grant | |
| provenance | self, server_name | Host identity for provider artifacts; result fields supply no authority. |
| artifact_admission | self, server_name, expected_provenance | Keep the package/account lease while persisting a provider result. |
| current |
harness/runtime/native_provider_write.py
| Function | Arguments | Source description |
|---|---|---|
| post_init | self | |
| _drain | task | |
| _offload | function, *args | |
| init | self, inner, prepared, arguments, claim, alive | |
| handle_async_request | self, request | |
| aclose | self | |
| init | self, store, scope, prepare, admission, credentials, enabled, timeout, max_calls, transport_factory, recheck | |
| _transport | binding | |
| _path | self, request_id | |
| _save | self, row, binding, result | |
| _saved | self, row, binding | |
| execute | self, server, tool, arguments, metadata, cancelled, alive | |
| active | ||
| _execute | self, server, tool, arguments, metadata, cancelled, alive | |
| deny_reference | uri | |
| claim | ||
| recover_saved_result | self, request_id, binding | Host reconciliation under the original runtime scope; no network I/O. |
| close | self |
harness/runtime/native_questions.py
| Function | Arguments | Source description |
|---|---|---|
| _expires | row | |
| _now | ||
| _identity | value | |
| _native_key | value | |
| init | self, state | |
| _db | self | |
| _public | row | |
| open | self, root_chat_id, actor_chat_id, owner, generation, native_request_id, params, actor_title, transport | |
| open_host | self, arguments, root_chat_id, owner, generation | |
| host_request | self, request_id, owner, root_chat_id | |
| _owned | db, request_id, owner, root_chat_id, generation | |
| get | self, request_id, owner, root_chat_id | |
| for_chat | self, root_chat_id, owner | |
| interrupt | self, request_id, owner, root_chat_id, reason | Reconcile a saved request after the host confirms its run has ended. |
| _response | row, action, answers | |
| answer | self, request_id, owner, root_chat_id, generation, action, answers, deliver, cancelled | |
| expire | self, owner, root_chat_id, generation, deliver, cancelled | Release expired native waits even when every browser is disconnected. |
| _finish_delivery | self, request_id, status, reason | |
| resolve_native | self, root_chat_id, generation, native_request_id | |
| retire_generation | self, root_chat_id, generation, reason | |
| recover | self | Call once on bridge startup after its workers have been reconciled. |
harness/runtime/native_skills.py
| Function | Arguments | Source description |
|---|---|---|
| _error | ||
| is_native_skill | identifier | |
| _hash | value | |
| init | self, store | |
| _descriptors | self, principal_id | |
| original | path | |
| list | self, principal_id | |
| resolve | self, identifiers, principal_id | |
| current | self, selection, principal_id | |
| inputs | self, identifiers, principal_id, selection, connection, cancelled | |
| native_skill_inputs | agent, resolved, run | |
| delivery_guard |
harness/runtime/openai_gateway.py
| Function | Arguments | Source description |
|---|---|---|
| _private_json | path, value | |
| _integer | value, minimum, maximum | |
| _input_bound | value | Conservative local estimate; keep source images intact, charge patches. |
| visit | item | |
| _has_opaque | value | |
| _price_admission | bound, output, web, evidence | |
| _client_tool_search | item, output | |
| prepare_request | body, max_output_tokens, allow_web_search, allow_native_tool_search | |
| flatten | items, depth | |
| prepare_compaction | body, allow_native_tool_search | |
| usage_receipt | response, request_id, reservation_id, pool_scope, parent_scope, admission | |
| capture_signals | self | |
| init | self, state, api_key, run_id, pool, transport, max_output_tokens, allow_web_search, maximum_run_usd, maximum_requests, unix_socket, allow_native_tool_search | |
| cli_config | self | |
| aenter | self | |
| aexit | self, *exc | |
| revoke | self | Immediately close admission before stopping the entire native tree. |
| _error | self, message, status | |
| _run_reserve | self, request_id, amount | |
| _run_settle | self, request_id, amount | |
| _admission_headroom | self | A preflight hint only; the subsequent reservations enforce races. |
| _finish | self, response, request_id, reservation_id, admission | |
| _count_input | self, body, admission, request_id | |
| handle | self, request | |
| stream |
harness/runtime/plugin_catalogue.py
| Function | Arguments | Source description |
|---|---|---|
| _documentation_candidate | value | |
| _source_url | path, revision, repository | |
| _instruction_evidence | source, path, revision, repository | Retain links and authentication mentions, never an executable instruction body. |
| _mcp_auth | details | Describe declared transport setup, without storing credential values. |
| _connection_setup | row, root, paths, revision, fetch, repository | |
| _https | value | |
| _child | root, value | Resolve a published relative path inside its own plugin package. |
| _strings | value | |
| _skill | path, revision, fetch, repository | |
| _populate_entry | row, root, paths, revision, fetch, repository | |
| build_catalogue | revision, tree, fetch | Build deterministically from a fixed Git tree and a public-file reader. |
| read_entry | entry | |
| materialize_external | snapshot, pins, fetch_archive | Resolve reviewed public package pins during refresh, never during serving. |
| fetch | path, limit | |
| _snapshot | ||
| catalogue | Return public reference data; connections and installation grants are separate. | |
| read_plugin | identifier | |
| refresh | revision, output, external_pins | |
| get | url, limit |
harness/runtime/plugin_routes.py
| Function | Arguments | Source description |
|---|---|---|
| _deny | status, code | |
| _offload | function, *args, **kwargs | |
| _run_store | method, *args, **kwargs | |
| invoke | ||
| _admitted | ||
| _header | request, name | |
| _identity | request, write | |
| _empty_body | request, required | |
| _plugin_id | identifier | |
| _installable | store | |
| _private_fd | path | |
| init | self, store | |
| _db | self | |
| _owner | principal | |
| list | self, principal | |
| begin | self, principal, plugin_id | |
| clear | self, principal, plugin_id | |
| lock | self | |
| _mutation | journal | |
| register_plugin_routes | app, store_for_workspace, installation_ready, installation_capabilities, revoke_plugin | Host callbacks receive only its authenticated request.state.workspace. |
| context | request, write | |
| ready | selected | |
| capabilities | selected, principal, store | |
| installed | request | |
| install | plugin_id, request | |
| remove | plugin_id, request |
harness/runtime/provider_tool_policy.py
| Function | Arguments | Source description |
|---|---|---|
| provider_prompt_policy | tool_effects | Host effect classification tunes provider prompts without rewriting schemas. |
harness/sdk/agent_inputs.py
| Function | Arguments | Source description |
|---|---|---|
| validate_schedule | self | |
| attach | self, store | |
| normalize | self, record, table | |
| collection_allowed | self, spec, datasets, owner | |
| validate_definition | self, spec | |
| definition_context | self, agent, chat_id, arguments | |
| prepare_record | self, record, context | |
| describe | self, record, db | |
| runnable | self, record | |
| validate_activation | self, record | |
| resource_ceiling | self | |
| resource_allowance | self, definition | |
| validate_resource_budget | self, definition, runs | |
| resource_admitted | self, run | |
| validate_wake | self, wake, definition | |
| recovered | self, db, run | |
| claimed | self, db, record, run | |
| finished | self, db, run, status | |
| refresh | self, definitions | |
| ready | self, definition, wake, agent, input_optional | |
| prepare | self, definition, wake, agent | |
| select | self, db, record, sources, source_records, screening, now, wake | |
| execution | self, definition | |
| recurring_ready | self, collection, principal | |
| context | self, agent, run, snapshot |
harness/sdk/capability_contract.py
| Function | Arguments | Source description |
|---|---|---|
| selection | value | Undeclared capabilities remain disabled; settings contain only booleans. |
harness/sdk/display_presentation.py
| Function | Arguments | Source description |
|---|---|---|
| extend_kit | extension | Merge a vertical's authored kit additions over the shared kit, into a fresh document. |
| merge | base, change | |
| init | self, problem | |
| listed | names | |
| _fields | schema | |
| build_schema | kit | The JSON Schema of a presentation, built from the kit. |
| _number | value | |
| _text | value | |
| _records | value, each, least, most | |
| _row | item | |
| holds | value | What a field holds, in words a sentence can carry. |
| bound | document, name, shape | The value a binding reads: the output's field of that name; for text, also a written text slot. |
| short | text, most | Text within most characters, ending on its last whole word there. |
| inert | text | Text a script wrote, as the page draws it: a link's own words stay and its address goes. |
| _inert_field | value | |
| _own_list | value, fields | A list a script wrote, as the kit's own fields of each entry: text, numbers and times. |
| init | self, kit, shapes, aliases, envelope, trusted_lists, row_fields, views, default_label | |
| output_fields | self, tile, canvas | The fields of a display's output a presentation can bind, each with the kit shapes it fits. |
| _problem | self, block, field, name, shape, needs, document, value, fixed | |
| check_output | self, spec, tile, canvas | Each binding of a presentation that the output leaves unfilled: [{block, field, bound_to, shape, needs, sentence}]. |
| family_blocks | self, family, canvas | A family's own blocks. With an output at hand, the ones its fields can fill join them. |
| default_presentation | self, display, output | The presentation a display has before one is saved: its label, a line of its series, a count, and the canvas family its definition names. |
| merge_presentation | self, saved, change, output | A saved presentation with a change of its tile, its canvas or both. A part replaces whole. A canvas named by its family alone takes that family's own blocks. |
| _named | self, value, most | |
| validate_presentation | self, spec, output, parts | A presentation that the kit and, with output, the display's current output can draw. |
| families_for | self, output | The kit's families for one output: each with its sentence, and whether the output's fields fill the family's own blocks. |
| _unit | self, reading, spec | The unit a reading carries on the page. A rate above 1 is the percentage itself: it reads with %, whatever unit came with it. A rate from 0 to 1 is a ratio and reads as one, unless its script published it with %. |
| _fraction | self, canvas, spec | |
| _tile_problems | self, reading, canvas, spec, series | Each binding of the tile that this reading leaves unfilled, as the page carries it. |
| canvas_for_page | self, canvas, spec | A canvas as the page reads it: the published fields, the text a script wrote made inert, a list a script wrote whole cut to the kit's own fields, the presentation's family and blocks, and each binding the output leaves unfilled. |
| apply_to_tile | self, row, spec, canvas, agent_id | A company display's tile row with its presentation applied: the names the workspace reads. |
| revise | self, current, change, output, expected_revision, saved_by, saved_at | Validate a change and advance its revision inside the adapter's write transaction. |
| display | self, display_id, owner_agent_id, output, presentation | Project an admitted output, with one explicit owning agent, into its tile and canvas. |
harness/sdk/display_runs.py
| Function | Arguments | Source description |
|---|---|---|
| canonical | value | |
| iso | epoch | |
| clean_policy | value | Validate the shared cadence and bounded runtime policy. |
| init | self, state, clock, filename, names, policy, keep_runs, scope_field, run_prefix | |
| execute | self, db, statement, values | |
| initialize | self, db | |
| connect | self, write | |
| _schedule | self, db, key | |
| _held | self, db, key | |
| state | self, owner, collection, scope_id, now | The scope’s schedule as the probe and the tools read it. |
| policy | self, owner, collection, scope_id | |
| set_policy | self, owner, collection, scope_id, changes, expected_revision | Change the scope’s run policy. expected_revision is the revision the caller read. |
| request | self, owner, collection, scope_id, by, only | Ask for a pass now. Requests made before the pass starts become that one pass. |
| claim | self, owner, collection, scope_id, trigger, stamp, day, now, lease_seconds | Take the scope’s lease and open a run row. None while another pass holds the lease. |
| _expire | self, db, key, row, now | Close the run of a lease that ran out and free the scope. |
| reap | self, owner, collection, scope_id, now | Close a pass whose lease ran out, so the probe reads the scope as it now stands. True when it closed one. |
| renew | self, run_id, lease_token, lease_seconds, now | Extend a lease its holder still has. False once the lease has moved on. |
| finish | self, run_id, lease_token, status, stamp, day, period, derived, outputs, errors, skipped, scripts, wall_ms, error, published, reread, now | Close a run row and free its lease. A completed pass that names its stamp records that stamp and day as processed. A failed pass backs off and leaves what was processed as it is. reread says the run stored outputs of another reading than the scope’s own (a chosen day from a host command): the next probe then runs the scope’s whole pass. |
| _public | self, row | A run as the tools and the page read it: no principal, no stamp, no file path. |
| record | self, owner, collection, scope_id, trigger, status, started_at, wall_ms, period, scripts, error | Write one closed run row beside the passes: a script's test. It holds no lease and leaves the scope’s schedule, its failures and its waits as they are. A display keeps its newest KEEP_TEST_RUNS test rows, so tests leave the scope’s pass rows in place. |
| forget_display | self, owner, collection, scope_id, key | Take a removed display out of the scope’s run history: its tests go, and each pass row loses the display's entries. A display added later under the same key starts with an empty history. |
| job_open | self, job, owner, collection, scope_id, display_id | Note a sandbox job before the broker hears of it: {'request_id', 'scope'}. |
| job_close | self, job | The broker confirmed the job released. |
| jobs_pending | self | Sandbox jobs a stopped process left open: [{'request_id', 'scope'}]. |
| runs | self, owner, collection, scope_id, limit | The scope’s runs, newest first. |
| last_run | self, owner, scope_id | The owner's newest pass, of one scope when it is named. A script's test is a row of the history and stays out of this: it is one display's test, and the scope’s pass stands. |
| due_reading | row, stamp, day, now, inputs_ready, daily_ready | One declared input reading through manual, changed-input and daily cadence gates. |
harness/sdk/display_scripts.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, code, message, line | |
| public | self | |
| validate_source | text, filename, max_bytes | A script's source, checked as text: size, encoding, syntax and one top-level def run(input). |
| init | self, directory | |
| start | self | |
| _refuse | self, reader, writer | |
| close | self | |
| _drain | task | Cleanup keeps its owner through a caller's cancellation. |
| init | self, path, clock, limits | |
| _connect | self | |
| numbers | self, company_id | {'host', 'company'}: jobs in the last 24 hours; 'total': every job this host's service took. |
| refused | self, company_id, retained | The fault code that keeps one more job of this company out now, else None. retained says the broker's retention upgrade is installed, which the host states with its event-runs switch. |
| count | self, company_id | Count one job. Returns the mark uncount takes. |
| uncount | self, mark | Take back the count of a job the broker refused. |
| init | self, contract, enabled, event_runs, client, runtime, socket_factory, poll_seconds, busy_waits, job_seconds, slot_wait, counts, clock, loop | |
| client | self | |
| runtime | self | |
| available | self, company_id, owner | Whether the broker of this host is the commissioned one: same profile, image and worker. |
| _turn | self, company_id, wait | Take the service's sandbox turn for a company. False when the turn is another company's or stays held for the whole wait. |
| run | self, company_id, owner, collection, display_id, revision, source, document, cancelled, opened, closed, wait_seconds, seconds | One job. Returns {status: 'succeeded', results, log, seconds, broker_run_id, input_sha256, input_bytes}, or {status: 'failed' / 'unavailable', error: {code, message, …}, seconds}. started says whether the broker holds a row for it: such a job counts against the day's numbers, and a job the broker refused or never heard of counts for nothing. |
| _uncount | self, mark | |
| _job | self, scope, request_id, snapshot, cancelled, state, job_seconds | |
| _clear | self, scope, request_id, state | Stop and release the job, whatever happened. True once the broker confirmed it. |
| recover | self, pending, closed | Clear jobs a stopped process left: [{'request_id', 'scope'}]. Returns the request ids cleared. |
harness/sdk/host.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, current, bind, model_context, resource, history_scope | |
| current | self | |
| bind | self | |
| init | self | |
| register | self, provider | |
| seal | self | |
| list | self, principal | |
| contains | self, collection, principal | |
| init | self, selected | |
| read_admission | self, actor, collection | |
| current | ||
| tool_context | self, context | |
| result_fields | self, name, content, success | |
| status_fields | self | |
| budget_fields | self | |
| member_cards | self, actor, collection, rows | |
| business_fields | self, actor, collection, value | |
| participant_delivery_current | self, chat_id | |
| provider_usage | self | |
| available_credit | self | |
| agent_capabilities | self | |
| validate_activation | self, definition, once | |
| usage_fields | self | |
| collection_names | self, principal | |
| catalogue | self | |
| draft_agent | self, template_id, collection, principal | |
| authorize_file | self, request, file_id, principal | |
| file_download | self, record, principal | |
| tick | self | |
| close | self | |
| connector_details | self, saved, connector_id, owner, collection | |
| connection_fields | self, value, principal, request | |
| source_options | self, principal, collection | |
| request_scope | self, request | |
| bare_lifespan | app, host |
harness/sdk/job_recipes.py
| Function | Arguments | Source description |
|---|---|---|
| ordered_steps | self | |
| _rows | reader, name, value, model, maximum | |
| load_jobs | reader, recipes, roles, classes, chats | Read exact vertical instruction bytes and validate cross-references once. |
| launcher_for | agent, chat_id | Only host-confirmed fixed purposes select an Organization recipe. |
| available | vertical, launcher | |
| instructions_for | agent, chat_id, vertical |
harness/sdk/layers.py
| Function | Arguments | Source description |
|---|---|---|
| modules | root | Active flat modules and package files; tests and frozen deployment closures stay outside. |
| _ownership | root | |
| _named | node | The module a call imports by a literal name: import_module('a.b') or import('a.b'). |
| imports | root | What each module imports from the other modules of the directory, read with ast. |
| crossings | graph, layer | The imports from layers 1 and 2 into layer 3 that a graph holds. |
| coupling | graph, layer | Measured numbers: modules per layer and imports per pair of layers ('2>3' reads 2 imports 3). |
| check | root, layer, recorded, graph | Every way the tree and this map disagree, as sentences. An empty list is a green ratchet. |
| by_layer | {layer: {what the modules do: (module, ...)}}, for the documents and the self-description. | |
| main |
harness/sdk/pack.py
| Function | Arguments | Source description |
|---|---|---|
| _need | condition, message | |
| _listed | names, last | |
| _object | where, value, required, optional | |
| _text | where, value, maximum | |
| _match | where, value, pattern, shape | |
| _choice | where, value, choices | |
| _rows | where, value, minimum | |
| _unique | where, values, noun | |
| _pairs | pairs | |
| _constant | name | |
| _parse | where, data | |
| _plain | char | A printing character, a line feed or a tab. |
| _bytes | where, path, limit | The bytes of one regular file that has a single name on disk and fits its size. |
| init | self, root | |
| read | self, where, relative, suffix, bounds, limit | |
| text | self, where, relative | |
| data | self, where, relative, bounds | |
| _skill | where, value, skill_ids | |
| _fixed_chats | reader, rows, skill_ids | |
| _agent_classes | rows | |
| section_slug | name | A section name as the sidebar keys it: lowercase letters and digits, every other run a dash. |
| _tile_sets | reader, rows | |
| _vocabulary | reader, value, parsed | |
| _strings | where, value, pattern, shape | |
| _seed_connections | where, value | The connections a seed needs: up to eight providers, each with its read scopes. |
| _skills | reader, value | |
| _templates | reader, where, value, skill_ids | |
| _ready_made | rows, classes, types | Each ready-made agent on offer takes an input of its class and reads event types of this vertical. |
| _capabilities | reader, value | The vertical's rows of the table of what works: rows of its own, and sentences for a harness row. |
| _surfaces | rows | |
| _connections | rows, skill_ids | |
| _data_sources | rows, skill_ids | |
| _wake_sources | rows | |
| _flow | rows | |
| manifest_path | self | |
| product | self | |
| prompt | self, name | The text of 'system' or 'fixed_chat_common', exactly as its file holds it. |
| fixed_chats | self | |
| purposes | self | {purpose: title} in the vertical's order. |
| choose_purpose | self | |
| fixed_chat | self, purpose | |
| fixed_chat_text | self, purpose | The standing instruction of one fixed chat by itself; None for a chat that carries the developer prompt alone. |
| fixed_chat_prompt | self, purpose | What a fixed chat adds to the developer prompt: the shared prefix, a newline, its own text. |
| agent_classes | self | |
| kinds | self | |
| agent_class | self, kind | |
| default_kind | self | |
| authority | self, kind | |
| tile_sets | self | |
| tile_set_path | self, tile_set_id | |
| tile_set | self, tile_set_id | The tile_set file, parsed, as it was read when the vertical loaded. |
| vocabulary | self | {'groups': [...], 'types': {event type: entry}}; empty for a vertical that declares zero event types. |
| recipes | self | Complete jobs with declared steps and completion criteria. |
| recipe | self, recipe_id | |
| sub_agents | self | |
| sub_agent | self, role_id | |
| skills | self | The skill seeds of a new company: id, name, description, instructions, required tools and connections. |
| ready_agents | self | The ready-made agents the vertical offers (ready_agents). |
| retired_ready_agents | self | Templates kept readable for the conversations that were started from them. |
| import_host | self | Load the explicitly declared composition module from this vertical's folder. |
| tool_families | self | |
| import_tool_families | self | Import declared families only from this vertical's own module tree. |
| tool_references | self | Every (place, tool name) the manifest relies on outside its skills. |
| check_tools | self, registered_names | The tool names of the manifest that a registry lacks, as sentences. Empty means every name is registered. |
| check_tile_sets | self, tool_specs | What stands between each tile_set and its install, as sentences. Empty means every tile_set installs. |
| skill_tool_gaps | self, registered_names | {skill id: the required tools these names lack}, for each skill they hold back. |
| surfaces | self | |
| builtin_capabilities | self | |
| connections_expected | self | |
| data_sources | self | |
| wake_sources | self | |
| flow | self | |
| demo | self | |
| capabilities | self | The vertical's rows of the table of what works: its own rows and its sentences for harness rows. |
| shell | self | What the web app needs to draw the sidebar and the pages (schema rocoto.harness-shell.v1). |
| digest | self | sha256 over the manifest and every file it names: one value for 'this exact template'. |
| _folder | source | |
| manifest_path | root | Read the canonical manifest first; an invalid new file never selects an old one. |
| _canonical_manifest | raw | |
| load | source | Validate one vertical and read every file it names. A string is a folder name under verticals/; a Path is a folder. |
| active | The vertical of this process, loaded on first use from the selected vertical and kept for its life. | |
| use | source | Serve another vertical for the length of a with block. For tests: one template per state directory (bind). |
| _binding | path | The vertical id a state directory records, or None while the record is absent. |
| _record | state, path, template_id | Write the record once and return the id on disk: this one, or the one another process wrote first. |
| bind | state, template | Tie one company's state directory to the vertical of this process, and return that template. |
| describe | template | A vertical in a dozen lines, for a person who is writing one. |
| main | arguments |
harness/sdk/tool_families.py
| Function | Arguments | Source description |
|---|---|---|
| owner | self | |
| dataset | self | |
| require_current | self | |
| require_parent | self | |
| _offload | function, *arguments | Retain admission until synchronous work finishes, including after cancellation. |
| validate_families | families, reserved_reads, reserved_writes | Validate the original family protocol without importing a vertical. |
| init | self, families | |
| names | self, surface | |
| read_names | self, surface | |
| specs | self, write, surface | |
| family_of | self, name | |
| declared | self, name, arguments | |
| invoke | self, context, name, arguments, surface | |
| build_registry | agent, families, definition_model | Construct the common product plus exactly the selected vertical families. |
| init | self, family | |
| getattr | self, name | |
| context | context |
harness/server.py
| Function | Arguments | Source description |
|---|---|---|
| web_asset | relative | Resolve shared shell assets or the active vertical's own web assets. |
| init | self, state, timeout, max_age, auth, agent, api_transport | |
| status | self | |
| create_app | state, index, messaging_provider_factory, phone_spend_factory, agent_factory, index_factory, read_agent_factory, managed_runtime_factory, builtin_provider_factories | |
| ready_workspace | selected | |
| recover_managed | ||
| close_workspace | selected | |
| abandon_workspace | selected | |
| lifespan | app | |
| tick | ||
| scope_member | selected, principal | |
| scope_members | selected | |
| install_scheduler | selected, environment_id | |
| phone_spending_ready | ||
| phone_entry | chat_id, entry | Write a contact card or an alert into its Tracking Agent chat, replacing its earlier state. |
| current_agent_authority | definition, actor | |
| current_signal_authority | signal | |
| workspace | environment | |
| services_for_environment | environment | |
| local_operator_only | request, call_next | |
| permitted | resources | |
| guarded_body | ||
| connection_identity | request, writable | |
| messaging_member | selected, principal | |
| messaging_members | selected | The company's current owners and operators, the two roles a participant holds. |
| messaging_authorized | selected, actor | |
| messaging_body | request, allowed, required | |
| organization_identity | request, collection, write | |
| messaging_actor | request, member_id, collection, write | |
| messaging_projection | request, member_id, collection | |
| organization_chats | request, collection | |
| organization_chat | request | |
| messaging_status | request, member_id, collection | |
| messaging_verification | request | |
| messaging_confirm | request | |
| messaging_hello | request | |
| registered_workspace_root | environment | |
| pending_signal_workspaces | Discover durable work without constructing another runtime for idle companies. | |
| cold_signal_sources | environment | |
| ingress_current | signal | |
| incoming_hook | environment, hook_id, request | |
| wake_sources | request, chat_id | |
| endpoint_secret | endpoint_id, request | |
| reveal_wake_secret | hook_id, request | |
| messaging_webhook | environment, request, channel | |
| phone_tick | selected | One pass of host alert delivery. A failed pass sends nothing and leaves the other ticks running. |
| messaging_tick | selected | |
| native_package_store | selected | |
| revoke_native_plugin | selected, principal_id, plugin_id | |
| native_installation_capabilities | selected, principal_id, store | |
| plugins_catalogue | ||
| plugin_details | plugin_id | |
| connections | request | |
| custom_identity | request, key, writable | |
| document_previews_for_workspace | selected | |
| custom_connections | request | |
| create_custom_connection | body, request | |
| build_connector | ||
| release | task | |
| custom_connection | connector_id, request | |
| custom_connection_package | connector_id, request | |
| custom_connection_secret | connector_id, request | |
| custom_connection_secret_remove | connector_id, name, request | |
| connect_provider | provider, request | |
| connection_flow | flow_id, request | |
| disconnect_provider | provider, request | |
| oauth_landing | ||
| oauth_script | ||
| oauth_callback | body, request | |
| home | ||
| script | ||
| question_box_script | ||
| question_box_style | ||
| logo | ||
| wordmark_font | ||
| connection_brand | filename | |
| vendor | filename | |
| workspace_artwork | request | |
| empty_state_artwork | ||
| style | ||
| interface_component | request | |
| diagram_component | ||
| shared_static | asset | |
| shared_vendor | filename | |
| source_icon | host | |
| theme | ||
| session_details | session | |
| health | ||
| session_info | request | |
| set_session | response, token, request | |
| login | body, request, response | |
| demo_session | request, response | |
| logout | request, response | |
| select_environment | body, request | |
| observers | request | |
| observe | body, request | |
| end_observation | request | |
| status | request | |
| business | request, collection | |
| business_map | request, collection, map_id | |
| business_profile | body, request | |
| onboarding | body, request | |
| profile_activity | request, scope, days | |
| usage | request, chat_id | |
| usage_settings | body, request | |
| installed_native_skills | request | |
| skills_catalogue | request | |
| skills_installed | request | |
| skills_install | body, request | |
| agent_catalogue | request | |
| participant_agent | record, request | An agent with participant reach shares its conversation with a selected participant. |
| owned_agent | agent_id, request, write | The agent for its owner. A participant reads it; its definition and controls stay the owner's. |
| public_agent | record, request | |
| capability_snapshot | request, dataset, chat_id | |
| workspace_capabilities | request, dataset | |
| agents_list | request | |
| agents_create | body, request | |
| agent_details | agent_id, request | |
| agent_update | agent_id, body, request | |
| activate_agent | agent_id, request, once, expected_revision | |
| agent_activate | agent_id, body, request | |
| agent_run | agent_id, body, request | |
| agent_pause | agent_id, request | |
| agent_report | agent_id, run_id, request | |
| chat | body, request | |
| release_task | task | |
| events | ||
| chats | request, include_archived | |
| chat_metadata | chat_id, body, request | |
| child_chat | chat_id, request | |
| require_parent_control | record | |
| answer_native_approval | chat_id, request_id, request | |
| answer_native_question | chat_id, request_id, request | |
| answer_credential_request | chat_id, request_id, request | |
| stop_chat | chat_id, request | |
| steer_chat | chat_id, body, request | |
| attachment | file, request | |
| attachment_image | attachment_id, request | |
| file_owner | request, write | |
| file_principal | request, file_id, write | |
| history_guard | ||
| list_files | request, chat_id, dataset | |
| get_file | file_id, request | |
| file_content | file_id, request | |
| rename_file | file_id, body, request | |
| mark_file_opened | file_id, body, request | |
| download_file | file_id, request | |
| preview_file | file_id, request |
harness/verticals/retail/camera_context.py
| Function | Arguments | Source description |
|---|---|---|
| timestamp | ||
| geometry | self | |
| content | self | |
| init | self, state, index | |
| connect | self | |
| camera_id | record | |
| sync | self | |
| _row | self, db, camera_id, collection | |
| _records | self, row | |
| _views | db, camera_id | |
| _public | self, db, row, details | |
| list | self, collection | |
| get | self, camera_id, collection | |
| observations | self, clips | |
| _source_hash | self, record | |
| propose | self, camera_id, body, origin, collection | |
| confirm | self, camera_id, draft_id, expected_revision, operator, collection | |
| get_context_for_clip | self, record | |
| get_context_for_clip | state, index, record | Host-only resolution for the model adapter; callers cannot supply context text. |
harness/verticals/retail/camera_onboarding.py
| Function | Arguments | Source description |
|---|---|---|
| _text | value, label, limit | |
| has_clock_input | self | |
| distinct_ids | cls, values | |
| names | cls, value, info | |
| public_stream_uri | cls, value | |
| connection_requirements | self | |
| credential_request_contract | connector_id, owner, chat_id, collection, reason | Return metadata for the existing request_custom_connector_credentials tool. |
| rtsp_connector_package | camera_name | Build a source-only connector package for the secure credential flow. |
| prepare_rtsp_connector | store, owner, collection, camera_name, chat_id | Create the prepared connector that the existing secure request handler uses. |
| request_rtsp_credentials | store, connector_id, owner, chat_id, collection, camera_name | Open the existing private credential card for a prepared RTSP connector. |
| public_defaults | Return a JSON-safe copy for setup UI and API projections. | |
| serialize_draft | draft | Stable JSON for a review record; secret values cannot enter this model. |
harness/verticals/retail/camera_onboarding_policy.py
| Function | Arguments | Source description |
|---|---|---|
| camera_onboarding_policy | Return a defensive public copy of the RTSP-first setup policy. |
harness/verticals/retail/catalog_finder.py
| Function | Arguments | Source description |
|---|---|---|
| readable_text | description | |
| classify | description | A stable product type for one item description: (key, label). |
| product_types | company, location_id | Group the camera-observed items of a location into product types. |
| write_product_types | company, location_id, path | |
| distinct | self | |
| import_found_products | company, location_id, path | Validate a finder result and save its products in the location catalog. No downloads. |
| main | argv |
harness/verticals/retail/catalog_image_model.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, state, api_key, transport | |
| call | self, owner, image, description, text, candidates, request_id | |
| extract_shelf | self, owner, image, request_id | One bounded catalog extraction; proposed labels and identifiers stay provisional. |
| _submit | self, owner, image_bytes, request_id, body, schema, max_output, prefix | |
| receipt | self, response, request_id, reservation_id, bound, max_output |
harness/verticals/retail/catalog_inspection.py
| Function | Arguments | Source description |
|---|---|---|
| canonical | value | |
| normalized | value | |
| geometry | value | |
| crop | image, box | |
| extract_frame | path, timestamp | Decode source pixels once on CPU. Host resolves path; model never does. |
| read_text | image | |
| link_catalog | text, candidates, object_grounded, proposed_id | Only a unique, visibly read catalog identifier confirms automatically. |
| init | self, state, authorized, source_resolver, catalog, publish_match, inspect_image, frame_reader, ocr, clock, object_verified | |
| connect | self | |
| require | self, owner, event | |
| process | self, owner, event, payload, job_id | |
| image | self, owner, key, event_lookup |
harness/verticals/retail/catalog_setup.py
| Function | Arguments | Source description |
|---|---|---|
| token_hash | token | |
| qr_svg | value | |
| init | self, state, locations, environment_id, clock | |
| connect | self | |
| overview | self, owner, collection, location_id | |
| import_products | self, owner, collection, location_id, rows, source_name, source_kind | |
| create_handoff | self, owner, collection, location_id, origin | |
| _handoff | self, db, token | |
| upload | self, token, data, extraction_consent | |
| photo | self, owner, key | |
| list_pending_photos | self, owner | |
| mark_photo_status | self, owner, key, status, detail | |
| complete_photo | self, owner, key, product_ids |
harness/verticals/retail/catalog_setup_routes.py
| Function | Arguments | Source description |
|---|---|---|
| register_catalog_setup_routes | app, workspace, access | |
| actor | request, write | |
| failed | exc | |
| setup | request, collection, location_id | |
| import_catalog | body, request | |
| import_file | request, file, collection, location_id | |
| handoff | body, request | |
| shelf_crop | key, index, request | |
| current | ||
| photo | key, request | |
| current | ||
| mobile_style | ||
| mobile_script | ||
| mobile_page | environment | |
| mobile_upload | environment, request, file, extraction_consent |
harness/verticals/retail/catalog_setup_tools.py
| Function | Arguments | Source description |
|---|---|---|
| specs | write | |
| make | name, description, properties, required | |
| call | agent, chat_id, collection, name, args, run |
harness/verticals/retail/compute_guard.py
| Function | Arguments | Source description |
|---|---|---|
| _utc | value | |
| _amount | value, name | |
| _code_root | Locate source ownership without assuming a particular install depth. | |
| _read_private | path | |
| validate_approval | path, workspace, planned_gross_usd, purpose, now | Validate an attested $0 provider cap, credits and gross headroom. |
| claim_approval | approval, now | Atomically consume an approval before image builds or remote execution. |
harness/verticals/retail/control_room_routes.py
| Function | Arguments | Source description |
|---|---|---|
| owner_directory | state, owner | |
| safe_file | root, relative | |
| read_bundle | selected, owner | |
| state_signature | selected, owner | A fingerprint of what a bundle read depends on: the manifest, the company's stores and the source lookup in force. A write to any of them changes it. |
| recent_bundle | selected, owner, interval | The owner's bundle, shared by the requests of one page. |
| register_control_room_routes | app | |
| context | request | |
| item_image | request, inspection_id | |
| allowed | ||
| bootstrap | request | |
| control_room_status | request | |
| control_room_revision | request | What an open page polls: the revision of its published data, for this session's owner. |
| control_room_asset | request, asset |
harness/verticals/retail/control_room_static.py
| Function | Arguments | Source description |
|---|---|---|
| static_code_file | asset | |
| is_static_viewer_request | path, method |
harness/verticals/retail/core_trackers/init.py
| Function | Arguments | Source description |
|---|---|---|
| load_recipe | business_type | |
| core_scripts | business_type | The maintained processor script of each Core Tracker of a business type, by tracker key. |
| core_script | tracker, scripts | The script this service runs for a tracker record in its own process, else None. |
| tracker_id | company_id, location_id, key | |
| install_core_trackers | company, location_id, business_type | Record the business type's Core Trackers for one location. Safe to repeat. |
| installed_trackers | company, location_id | The location's trackers: core first in recipe order, then the company's own. |
| add_tracker | company, location_id, key, label, observes, event_types, script, agent_id | Add one of the company's own trackers beside the core set. |
| agent_tracker_key | agent_id | The tracker key of a Tracking Agent's record: stable, and outside every recipe's keys. |
| agent_tracker | state, owner, collection, agent_id | The tracker record linked to a Tracking Agent, once it has one. |
| link_tracking_agent | company, location_id, agent, event_types | The tracker record of a Tracking Agent at a location, written once through add_tracker. |
| remove_tracker | company, location_id, key | Remove one of the company's own trackers. Core Trackers stay. |
| update_tracker | company, location_id, key, changes, expected_revision | Change one of the company's own trackers. Core Trackers follow their recipe. |
| tracker_records | state, owner, collection | The owner's saved tracker records of a collection, read without opening the company for writing. |
| location_trackers | state, owner, collection, location_id, agents, allowed | What the harness lists for a location: Core Trackers, then the customer's own. |
harness/verticals/retail/core_trackers/basket.py
| Function | Arguments | Source description |
|---|---|---|
| run | company, location_id, period, data | |
| measure | x, y | |
| row | basket |
harness/verticals/retail/core_trackers/common.py
| Function | Arguments | Source description |
|---|---|---|
| epoch | text | |
| day_period | day | |
| days_period | last_day, days | |
| when | period | The period as a sentence says it: «on Sat 10 Oct 2026», «from 4 Oct to 10 Oct 2026». |
| buckets | period | |
| within | row, a, b, key | |
| camera_name | self, camera_id | |
| available | self | The sources this location has, named as the recipe's requires names them. |
| missing | self, key | |
| read_location | company, location_id | Load one location's records once for a tracker run. |
| money | amount, currency | An amount as a person reads it: «€10.60», or «10.60 CHF» for a currency without a common sign. |
| number | value, digits | |
| series | period, measure | |
| trend | period, measure, days | |
| event_row | event | The tile's event shape: one observation behind the number. |
| by_camera | data, rows_ | |
| busiest | points | |
| plural | value, unit | |
| count_summary | value, unit, period, points, daily | |
| count_tracker | key, unit, data, period, rows_ | A count over the period: the tile number, its series, and the event rows on the canvas. |
| needs | data, key, period, phrase | A measure whose source is missing: state "needs" with its three words. |
| publish | data, key, period, value, unit, series, events, canvas, summary, trend, state, needs, tile_extra | Write the tracker's output revision: canvas (full view) and tile (its compact summary). |
| outputs | company, location_id | Current output of each installed tracker, core first. |
harness/verticals/retail/core_trackers/conversion.py
| Function | Arguments | Source description |
|---|---|---|
| run | company, location_id, period, data |
harness/verticals/retail/core_trackers/empty_shelves.py
| Function | Arguments | Source description |
|---|---|---|
| run | company, location_id, period, data |
harness/verticals/retail/core_trackers/picked_up.py
| Function | Arguments | Source description |
|---|---|---|
| run | company, location_id, period, data |
harness/verticals/retail/core_trackers/presentation.py
| Function | Arguments | Source description |
|---|---|---|
| record_id | tracker | |
| public | record | A saved presentation as a tool, a route and the page carry it. |
| belongs | saved, tracker | Whether a saved presentation is this tracker's own. A tracker's id comes from its key, so a tracker made again under a removed tracker's key meets that one's rows until they are cleared: a presentation saved at a later revision than the tracker has reached was the earlier one's. |
| presentation_of | tracker, saved, output | A tracker's presentation: the saved one, or its default at revision 0. |
| forget | db, owner, tracker | Remove a tracker's saved presentation and every kept revision, inside the caller's transaction. A tracker's removal calls this beside the rows of its script. |
| forget_removed | company, location_id, trackers | Clear the presentations of trackers a location has removed; returns how many. The page pass calls this with the location's trackers, so a key used again starts with its own presentation. |
| _read | state, query, values | |
| saved_presentations | state, owner, collection | The owner's saved presentations of a collection by tracker id, read without opening the company for writing. |
| saved_revisions | state, owner, tracker | Every kept revision of one tracker's presentation, newest first. |
| current_output | state, owner, tracker | The tracker's current output revision, once it has one. |
| save_presentation | company, tracker, change, expected_revision, saved_by, clock | Save a company tracker's presentation as its next revision; returns it in its public form. |
harness/verticals/retail/core_trackers/product_interactions.py
| Function | Arguments | Source description |
|---|---|---|
| run | company, location_id, period, data |
harness/verticals/retail/core_trackers/put_back.py
| Function | Arguments | Source description |
|---|---|---|
| run | company, location_id, period, data |
harness/verticals/retail/core_trackers/queue_time.py
| Function | Arguments | Source description |
|---|---|---|
| run | company, location_id, period, data | |
| measure | x, y |
harness/verticals/retail/core_trackers/run.py
| Function | Arguments | Source description |
|---|---|---|
| zone_day | zone, now | The calendar day at now (epoch seconds) in a named timezone, UTC without one. |
| location_zone | company, location_id | The timezone of the location's coordinates, when it has them. |
| local_day | company, location_id, now | The location's current calendar day: in the timezone of its coordinates, UTC otherwise. |
| observed_day | data | The UTC day of the location's latest observation, once it has one. |
| latest_day | data | The UTC day of the location's latest observation. |
| brief | error, what | A run row's words for a failure: the product's own sentence, or the kind of fault. |
| run_trackers | company, location_id, period, only, deadline, custom, clock, defer | Derive the location's records, read them once, then run each installed tracker's processor. |
| _taken | key, output, outputs, errors, script_runs | File what custom returned for one script tracker: its run, its sentence and its output. |
| run_script_trackers | company, location_id, period, data, trackers, custom | The script trackers a pass deferred, each through custom, in order. The caller sets PASS around this with the script time of the pass. One tracker's fault stays its own. |
| sandboxed | tracker | Whether a company's tracker has a processing script: a published sandbox script, or a script name on its record. Either way its code stays out of this process. |
| reading_periods | company, location_id, data, last_day | The week, the month and the year a location's trackers are read over: {name: period}. |
| period_readings | company, location_id, last_day, data | Each tracker's output over the week, the month and the year. Nothing is stored. |
| main | argv |
harness/verticals/retail/core_trackers/sales.py
| Function | Arguments | Source description |
|---|---|---|
| chosen | data, a, b | Till transactions when the period has them, else the estimated sales. |
| run | company, location_id, period, data | |
| row | sale |
harness/verticals/retail/core_trackers/visitors.py
| Function | Arguments | Source description |
|---|---|---|
| run | company, location_id, period, data | |
| row | visit |
harness/verticals/retail/cosmos_archive_import.py
| Function | Arguments | Source description |
|---|---|---|
| sha | path | |
| collapse | text | A doubled sentence ("A. A.") reads once; every other text stays as the model wrote it. |
| fenced_json | text | The final JSON of a model answer, with or without a reasoning block or a code fence. |
| answer_events | answer | Flatten the two event shapes Cosmos returns: a list, or person -> type -> event. |
| presence | tracks | Tracker person -> the source times the tracker saw that person. |
| person_of | label, seen | |
| validate | raw, seen, start_s, end_s, vocabulary | Structure check for one raw event. Returns (fields, None) or (None, reason). |
| retail_profile | company, location_id | The saved observation profile for the retail vocabulary of this location. |
| drain | company, pipeline | Run the projection work the stream queued. Image inspection of real evidence stays queued. |
| ingest_recording | company, location_id, camera_id, recording, tracks, windows, profile, vocabulary, data_basis, evidence, title, files, clip, pipeline, publisher_note | Admit one recording: source, tracked visitors, model events, receipts. |
| host_tracks | viewer | The archive's viewer track format, as the tracker frames ingest_tracks reads. |
| archive_windows | root, clip, duration, suffix | The preserved answer windows of one clip for one model, or None when the file is absent. |
| valid_count | windows, seen, vocabulary | |
| import_archive | company, archive_root, location_id, room_id, clips, cameras, capture_starts, publish_media | Ingest the listed archive clips into the location. Safe to repeat. |
| publish | source, relative | |
| main | argv |
harness/verticals/retail/cosmos_inspect.py
| Function | Arguments | Source description |
|---|---|---|
| inspection_complete | result | Check answer completion, separately from metering and visual correctness. |
| execution_profile | model_id, quality_profile | |
| processor_settings | model_id, quality_profile | |
| audit_processor_inputs | processor, inputs, video_metadata, settings | Record measured tensors and sampling, without storing hidden model reasoning. |
| plain | value | |
| validate_requests | requests, clip_ids | |
| final_text | text | |
| parse_answer | text, clip_ids | |
| parse_comparison | text, clip_ids | Map fixed attachment positions to source IDs; the model never chooses IDs. |
| camera_context_text | context | Render host-resolved operator notes as bounded scene data. |
| inspection_content | clip_ids, source_records, paths, prompt | |
| _derived_input | entry, company_state | |
| load_manifest | path, quality_profile, company_state | |
| inspect_batch | clips, requests, model_id, quality_profile | Importable remote function; all GPU work is contained in one bounded call. |
| create_worker | modal, model_id, profile | |
| run_inspection | clips, requests, approval_path, output, check, query_budget, model_id, warm_benchmark, quality_profile, company_usage | |
| stop_own_app | app_id | Stop only this verified Rocoto inspection app, never all workspace apps. |
| stop | ||
| _worker_command | interpreter, *arguments | Keep fresh inspections and their stop path in the selected harness source layout. |
| _stop_remote_receipt | directory, interpreter, environment | |
| cache_results | result, state, run_id | Persist model output as observations/candidate connections with provenance. |
| _cache_results_unlocked | result, state, run_id | |
| _cache_key | clips, requests, model_id, quality_profile | |
| _prepare_source_clip | record, path, quality_profile | Decode a bounded interval with codec-compatible dimensions. |
| _request_asset_key | requests, model_id, quality_profile | |
| _reuse_prepared_source | record, path, state, request_key, quality_profile | |
| _modal_runtime | modal_python | Resolve host-owned Modal credentials only for a fresh inspection. |
| _inspect_sources | ids, requests, index, state, approval_path, query_approval_path, modal_python, model_id, quality_profile | |
| inspect | clip_id, prompt, index, state, approval_path, query_approval_path, compare_clip_id, modal_python, model_id, quality_profile | Inspect one source or a pair using the exact current question. |
| inspect_live | clip_ids, prompt, index, state, approval_path, compare_views, modal_python, model_id, quality_profile | Fresh Cosmos video reasoning, with exact-question/source-hash cache reuse. |
| main | ||
| terminate | signum, frame |
harness/verticals/retail/cosmos_retrieval.py
| Function | Arguments | Source description |
|---|---|---|
| _file_identity | path | |
| _atomic_write | path, content | Publish one durable file; unique temporary names allow concurrent import preparation. |
| _sync_directory | path | |
| generation_paths | state, marker | Resolve committed files; callers retain one marker for a coherent view. |
| _validate_payload | clips, embeddings, report, marker | |
| load_generation | state, allow_legacy | Read and verify one complete committed snapshot without loading a model. |
| _publication_lock | state | |
| _stage_generation_locked | state, records, vectors, report | |
| _promote_generation_locked | state, marker | |
| _publish_generation_locked | state, records, vectors, report | |
| _publish_generation | state, records, vectors, report | Explicit full replacement used by the historical offline import command. |
| _merge_metadata | records, vectors, asset_metadata | |
| _combined_report | records, prior, parent_generation | |
| merge_index | state, records, vectors, asset_metadata, expected_generation, replace_clip_ids, before_commit | Commit additive source imports under one load/merge/publication lock. |
| promote | ||
| init | self, state | |
| use_text_encoder | self, source | Host-only sharing of the pinned CPU model, preserving company indexes. |
| _reload | self | |
| refresh | self | Load a newly committed generation, preserving the index and encoder on failure. |
| _encoder_ready | self | |
| _encoder_verified | self | |
| _load_model | self | |
| _encode_text | self, query | |
| search | self, query, limit, dataset | |
| status | self | |
| build | self, *args, **kwargs | |
| install_text_assets | encoder_path, tokenizer_zip, metadata_path, state | Install a local export without downloading or executing model source code. |
| prepare_index | embedding_files, manifest_files, state, baseline_state, excluded_datasets | Convert authenticated worker artifacts to a searchable source-video index. |
| main |
harness/verticals/retail/cosmos_stream_bridge.py
| Function | Arguments | Source description |
|---|---|---|
| digest | value | |
| final_answer | text | Accept final JSON only, including official think/answer tags and JSON fence. |
| prepare_prompt | pipeline, owner, context, clock_basis, source_offset_s, tracker_labels, tracker_receipt, input_preparation | Resolve the saved native profile and persistable host input contract. |
| _admit_result | pipeline, owner, prepared, envelope, input_trace | Validate the stock signal envelope, original trace and model's structured final. |
| admit_result | pipeline, owner, prepared, envelope, input_trace | Preserve authorized raw attempts, including rejected clocks/labels/answers. |
| connect_stock_results | element, pipeline, owner, prepared_for, trace_for, on_receipt | Attach to stock GStreamer's documented vlm-result signal without SDK edits. |
| receive | _element, stream_id, start_sec, end_sec, result_text |
harness/verticals/retail/demo_guidance.py
| Function | Arguments | Source description |
|---|---|---|
| _questions | *prompts | |
| demo_guidance | environment_id, clips |
harness/verticals/retail/discovery.py
| Function | Arguments | Source description |
|---|---|---|
| _unit | rows | |
| _distribution | scores | |
| _cluster | vectors, groups | Deterministic spherical k-means, bounded fitting sample; assign every row. |
| _merge_intervals | records, vectors, scores, selected | |
| _representatives | members, records, vectors, scores, count | |
| _clip_result | record, score | |
| _interval_result | interval, records, scores | |
| discover_patterns | index, query, dataset, groups, candidate_limit, score_threshold, representatives_per_group, group_id, interval_id, offset, limit | Score every scoped window; group selected candidates and page the evidence. |
harness/verticals/retail/evidence_captions.py
| Function | Arguments | Source description |
|---|---|---|
| _canonical | value | |
| _hash | value | |
| _identity | value | |
| _text | value, maximum | |
| pricing | model | |
| init | self, state, api_key, model, pool, transport, authorized, clock | |
| connect | self | |
| _current | self, scope, current | |
| _observation | self, clip, observation_ref | |
| _emit | self, emit, event | |
| caption | self, scope, index, clip_id, question, observation_ref, current, emit | |
| _plain | value, partial | |
| _receipt | self, response, request_id, reservation_id, input_bound |
harness/verticals/retail/evidence_presentation.py
| Function | Arguments | Source description |
|---|---|---|
| build_presentation | arguments, index, collection, public_clip |
harness/verticals/retail/execution_policy.py
| Function | Arguments | Source description |
|---|---|---|
| admit_fresh_inspection | maximum_usd |
harness/verticals/retail/focus.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, state, sample_fps, max_width, max_seconds | |
| _histogram | frame, box | |
| _features | gray, box | |
| _flow | previous, current, points, box | |
| build | self, record, normalized_bbox, anchor_seconds | |
| _track | self, path, clip_id, start, duration, box, anchor |
harness/verticals/retail/import_control_room_bundle.py
| Function | Arguments | Source description |
|---|---|---|
| sha | path | |
| write_json | path, value | |
| source_file | root, relative | |
| make_poster | video, target, at_s | |
| viewer_tracks | raw | |
| import_bundle | run_root, state, owner, location_id, room_id, camera_ids, reviews, collection, location_name, weather, cover_image, poster_builder, visit_scope | Import one location while its scheduler waits, including optional tracked visits. |
| _import_bundle | run_root, state, owner, location_id, room_id, camera_ids, reviews, collection, location_name, weather, cover_image, poster_builder | |
| carried_page_data | destination | What publish_core_trackers wrote into this bundle, so a re-import keeps it. |
| page_lock | destination | One writer of a page's data at a time: a tracker pass, a host import and a saved presentation take turns. |
| reading | output | One period's reading as a tile carries it: its number, its series and its canvas, each list cut to ROWS. |
| in_currency | tiles, currency | A company tracker's amount is written in the location's currency, the one the catalog names, when its output names none: Home and the canvas then write the same characters. |
| tracker_page | company, location_id, readings, only, kept | The tiles and the canvases of a location's trackers as the page reads them: (tiles, canvases keyed by tracker). |
| tracker_row | company, location_id, tracker_id, currency, kept | One company tracker's tile row and canvas as the page carries them: its stored output and its week, month and year readings with its presentation applied, and an amount in the location's currency. (None, None) while the tracker is still to get a row of its own. A saved presentation and a canvas read ahead of the page both assemble here, so a tile and a canvas come out in one pe |
| location_currency | company, location_id | The currency a location's catalog names, the one write_page gives its page. |
| show_presentation | company, location_id, tracker_id | Carry one company tracker's saved presentation into the owner's published page, without a tracker pass: its own row and canvas are assembled again from its stored output and readings. Returns whether the page data changed. |
| publish_core_trackers | company, location_id, location_name | Carry a location's trackers in the page data, core first then the company's own. |
| write_page | company, location_id, readings, destination, location_name | The page data of publish_core_trackers, assembled and written while its lock is held. |
| generated_cover | relative | Select a shipped generic illustration, preserving its recorded provenance. |
| ingest_tracker_visits | run_root, state, owner, scope | Project actual tracker presence through current source/camera authority. |
| main | ||
| member | owner |
harness/verticals/retail/import_cosmos_response.py
| Function | Arguments | Source description |
|---|---|---|
| load | path | |
| write | path, value | |
| main | argv |
harness/verticals/retail/import_stream_response.py
| Function | Arguments | Source description |
|---|---|---|
| main | argv |
harness/verticals/retail/imported_media.py
| Function | Arguments | Source description |
|---|---|---|
| imported_path | path | |
| imported_record | record | |
| require_sandbox_derivation | record, purpose | |
| _number | value, low, high | |
| _integer | value, low, high | |
| _identity | info | |
| path | self | Compatibility reference only; HTTP/vision consumers use open/read_bytes. |
| open | self | Hash the held FD, check its identity, then rewind it for byte serving. |
| read_bytes | self, maximum | |
| verify | self | |
| init | self, state | |
| _open | self, relative, sealed | |
| _authority | self, asset_id | |
| resolve | self, record | |
| _resolve | self, record | |
| frame_input | self, record | The available image is the first 640px playback frame, not a video verdict. |
| byte_response | file, range_header, attachment | Range-capable HTTP response over a verified held FD, with bounded chunks. |
| chunks |
harness/verticals/retail/inspection_previews.py
| Function | Arguments | Source description |
|---|---|---|
| repr | self | |
| _identifier | value, clip | |
| _metadata | frame | |
| _jpeg | raw | |
| _current | guard | |
| _canonical | value | |
| _unique_object | pairs | |
| init | self, state, create | |
| repr | self | |
| _check_paths | self | |
| _initialize | self | |
| _descriptor | receipt_id, index, clip_id, metadata, sha256 | |
| save | self, owner_principal_id, chat_id, dataset, clip_id, frames, guard | Atomically admit up to four copied frames; call from drained host offload. |
| get | self, owner_principal_id, receipt_id, index, chat_id | Read one private frame; absent/foreign scope returns None without writes. |
| tool_previews | name, content, success | Project host inspection metadata, never arbitrary URLs or model image data. |
harness/verticals/retail/intake_projection.py
| Function | Arguments | Source description |
|---|---|---|
| public_import | view | |
| init | self, state, company_id, collections | |
| collections | self, actor | |
| _rows | self, actor, collection, allowed, limit, offset | |
| snapshot | self, principal, collection, read_only, limit, offset |
harness/verticals/retail/investigation_plans.py
| Function | Arguments | Source description |
|---|---|---|
| meaningful_strings | self | |
| limits | self | |
| _now | ||
| _digest | value | |
| init | self, state, index | |
| connect | self | |
| _snapshot | index | |
| _model | index | |
| _index_snapshot | self, index, dataset | |
| context | self, dataset | |
| save | self, dataset, chat_id, document | |
| get | self, plan_id, dataset, chat_id | |
| get_receipt | self, receipt_id, dataset, chat_id | |
| get_inspection | self, receipt_id, dataset, chat_id | |
| record_inspection | self, plan_id, dataset, chat_id, category_ids, question, clip_ids, result | Record a complete host inspection; model observations remain interpretations. |
| _cached_encoder | self, index, model, stats | |
| encode | query | |
| _intervals | candidates | |
| retrieve | self, plan_id, dataset, chat_id, index, limit_per_query |
harness/verticals/retail/library.py
| Function | Arguments | Source description |
|---|---|---|
| read_json | path, default | |
| init | self, state, index | |
| catalog | self | |
| folder | value | |
| metadata | self, path, record | |
| public_clip | clip | |
| public_asset | self, asset, include_clips | |
| listing | self, collection, folder | |
| resolve | self, asset_id, collection | |
| original | self, asset_id, collection | |
| source_details | self, record | |
| _results | self | |
| _matching_result | self, description, clip_id | |
| _input_metadata | self, result_path, clip_id, sha256 | |
| descriptions | self, record |
harness/verticals/retail/link_download.py
| Function | Arguments | Source description |
|---|---|---|
| require | value, code | |
| validate_url | value | |
| classify | value | |
| media_magic | data | |
| metadata | headers, url, max_bytes | |
| chunks | self | |
| init | self, resolver, network_backend, ssl_context | |
| open | self, url, current, max_bytes |
harness/verticals/retail/link_intake.py
| Function | Arguments | Source description |
|---|---|---|
| digest | value | |
| drain | task | |
| offload | fn, *args, **kwargs | |
| init | self, state, store, host, authorized, enabled, transport | |
| db | self, write | |
| _row | self, db, actor, identity | |
| _authority | self, actor, collection, write | |
| _public | self, row | |
| create | self, actor, collection, url, idempotency_key | |
| get | self, actor, identity | |
| list | self, actor, collection | |
| _current | self, actor, identity | |
| _lease | self, name | |
| _slot | self | |
| _update | self, actor, identity, **values | |
| start | self, actor, identity | |
| run | self, actor, identity | |
| rejected | ||
| _run | self, actor, identity | |
| begin | ||
| _recover_upload | self, actor, identity | |
| _acquire | self, actor, identity, row | |
| _finish_cancel | self, actor, identity | |
| cancel | self, actor, identity | |
| _cancel | self, actor, identity | |
| finish | ||
| ready | self | |
| reconcile | self | |
| repair | ||
| close | self | |
| member_current | state, access_state, environment, owner | Cheap host company-membership fence; browser logout is not revocation. |
harness/verticals/retail/link_routes.py
| Function | Arguments | Source description |
|---|---|---|
| public | value | |
| call | fn, *args, **kwargs | |
| register_link_routes | app, service_for_workspace | |
| context | request, write | |
| row | service, actor, identity, collections | |
| response | value, code | |
| listing | request | |
| create | request | |
| detail | identity, request | |
| retry | identity, request | |
| cancel | identity, request |
harness/verticals/retail/location_context.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, status | |
| context_enabled | environ | |
| map_provider | environ | The commissioned map provider and its key: Mapbox first, then Google; None keeps the tiles. |
| claim_provider | environ | Read the provider key once and take both names out of the environment, so no child process inherits it. |
| host_ledger | environ | The provider-call ledger every server process of this host's user shares; None where the user has no home. |
| picture_request | provider, secret, place, width, height | The one outside request for a picture: the shop's coordinates, the shape, the key. |
| provider_png | body, width, height | The provider's answer as one plain PNG of the asked shape at two pixels per point. |
| kept_provider_png | picture, width, height | True for a kept file that is still the PNG this service saved for that shape. |
| valid_for | headers | How long the provider says its picture stays valid, inside this service's bounds. |
| init | self, path, daily, monthly, clock | |
| _now | self | |
| _counts | table, stamp | |
| _write | self, ledger | |
| _ledger | self, write | |
| commission | self | Make the ledger where none stands. True when this call made it; a standing ledger is left as it is. |
| reserve | self, count | Count these calls against the day and the month before they leave. False admits none of them. |
| used | self | Today's and this month's counts; a ledger that cannot be read reads as full. |
| init | self, path, caps, clock | |
| _day | self | |
| _today | self, ledger | |
| _ledger | self, write | |
| reserve | self, kind, count | Count these calls against today's cap before they leave. False admits none of them. |
| used | self, kind | Today's count; an unreadable ledger reads as a full day. |
| _number | value, low, high | |
| _optional | value, low, high | |
| _stamp | value, pattern | |
| checked | raw | The upstream answer reduced to the measured values this product shows, each one in range. |
| column | table, name, count, convert | |
| code | value | |
| flag | value | |
| condition | code, is_day | |
| city_of | address, zone | The city a person would say for this address. Stored text only: no lookup. |
| forecast | saved, place, now, fetched, stale | The answer the page reads, cut to the hours and days ahead of this moment at the shop. |
| hour | index | |
| day | index | |
| tile_position | latitude, longitude, zoom | Fractional slippy-map tile coordinates of a point (Web Mercator). |
| tile_block | latitude, longitude, zoom | The 3x3 tiles around the shop and the shop's pixel inside that block. |
| compose | tiles, point | One square picture centred on the shop, cut from the 3x3 block. |
| theme_tone | path | The map tone the theme names (saturate, contrast, brightness), for this service to bake into the tiles' picture. |
| find | node | |
| toned | image | The tiles' picture in the theme's quiet tone; the page shows every map picture as it arrives. |
| credited | picture, width, height | The picture at the asked shape, the shop still at its centre, the map's credit in its corner. |
| lettering | size | |
| init | self, directory, transport, clock, enabled, provider, picture_ledger | |
| key | place | |
| _lock | self, kind, key | |
| _resting | self, kind, key | |
| _keep | self, table, key, value, limit | |
| _get | self, client, url, params, limit | One bounded read: a 200 answer of at most limit bytes. |
| _client | self | |
| _fetch_weather | self, place, key | |
| weather | self, place | |
| answer | saved, stale | |
| fresh | ||
| _picture_path | self, key | |
| _saved_picture | self, key | |
| _save_picture | self, key, picture | |
| _saved | self, key, path | |
| _save | self, key, path, picture, stamp | |
| _fetch_picture | self, place, key | |
| one | client, column, row | |
| _fetch_provider | self, place, key, width, height | One counted call: (picture, seconds it stays valid), or None with the shape at rest. |
| _provider_picture | self, place, width, height | The commissioned provider's picture of this shape, kept while the provider says it is valid. None hands the map to the tiles. |
| kept | ||
| fresh | ||
| map | self, place, width, height | |
| fresh | ||
| locate | selected, owner, location_id | The session's location and its coordinates, read through the company's own stores. |
| service_directory | app | The service's own state directory, beside its transfer ledger. |
| register_location_context_routes | app, context | Two reads behind the control room's own session and company checks. |
| place_of | request, location_id | |
| location_weather | request, location_id | |
| location_map | request, location_id, width, height | |
| main | argv | Host commands for the map provider's call ledger. |
harness/verticals/retail/location_intelligence.py
| Function | Arguments | Source description |
|---|---|---|
| encoded | value | |
| evidence | self | |
| provenance | self | |
| displayed_price | value | |
| payment_evidence | events | |
| identity | self | |
| sourced | self | |
| coordinates_from_weather | value | Import an existing sourced configuration; perform no geocoding or lookup. |
| proof | self | |
| valid | self | |
| init | self, state, scope, monitoring, clock | |
| connect | self, write | |
| _rows | self, owner, kind | |
| _get | self, owner, kind, key | |
| _put | self, owner, kind, value, immutable | |
| authorized | self, owner, collection, location_id, write | |
| configure_location | self, owner, definition | |
| save_product | self, owner, definition | |
| _event_reader | self, owner | One read names every event's source; each source's access is decided once per caller. |
| readable | source_id, dataset | |
| products | self, owner, collection, location_id, reader | |
| _event_place | self, owner, event | |
| _source_place | self, owner, source, collection | |
| ingest_tracks | self, owner, source_id, tracks, tracks_sha256 | Trusted host adapter for real tracker observations, independent of VLM events. |
| ingest_event | self, owner, event, job_id | |
| _project_visit | self, owner, event | |
| resolve_location | self, owner, event | |
| catalog_products | self, owner, event | |
| apply_product_match | self, owner, event_id, match | |
| product_match | self, owner, event_id | Read a saved matching receipt; this endpoint starts no image work. |
| save_daily_fact | self, owner, definition | |
| _metrics | events, facts | |
| total | field | |
| _projection | self, events, products, facts | |
| snapshot | self, owner, collection, now, scenario |
harness/verticals/retail/location_intelligence_routes.py
| Function | Arguments | Source description |
|---|---|---|
| register_location_intelligence_routes | app | |
| location | request, collection | |
| catalog | request, collection, location_id | |
| visit_basket | request, source_id, track_id, at_s | |
| current |
harness/verticals/retail/media.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, state | |
| _derivatives | self, owner_principal_id | |
| source_cut | self, record, owner_principal_id | |
| inspect | self, record, owner_principal_id | |
| clip | self, record, source_resolution, owner_principal_id | |
| save_attachment | self, data, name |
harness/verticals/retail/media_derive.py
| Function | Arguments | Source description |
|---|---|---|
| _valid_number | value | |
| validate_request | asset_id, collection, clip_id, purpose, start, end, frame_seconds | |
| _command | source | |
| _audio_probe | source, work, limits, deadline | |
| _source_frame | index, timing, timebase, origin | |
| _file | path, maximum | |
| _video_metadata | path, work, limits, deadline | |
| derive | asset_id, collection, clip_id, purpose, start, end, frame_seconds, source, output, limits | Publish output/derived atomically; the caller owns scope and job fencing. |
| _probe_image | path, work, limits, deadline | |
| main |
harness/verticals/retail/media_exports.py
| Function | Arguments | Source description |
|---|---|---|
| _now | ||
| _rational | value | |
| _fraction | value, minimum, maximum | |
| _text | value, limit, empty | |
| _safe_file | path, root | Only regular, nonsymlink files inside this host-selected company state. |
| _fingerprint | path | |
| _public_reference | value | |
| _public_note | value, root, source, limit | |
| _check | stop | |
| _transfer | stop, source, destination, limit | Hash/copy in bounded chunks on a worker thread, with cooperative cancellation. |
| _joined | task | |
| _thread | operation, *args | |
| _blocking | operation, *args | Join short state mutations before propagating cancellation to cleanup. |
| _probe | path | |
| init | self, state, index, media | |
| connect | self | |
| _owner | owner | |
| _key | key | |
| _lock | self | |
| _save | self, record | |
| _admit | self, document, dataset, owner, duration | |
| _imported_source | self, record, owner | |
| _verified_receipt | self, identity, source_record, owner | |
| _selection | self, document, dataset, owner | |
| _public | record | |
| get | self, payload_id, owner_principal_id, dataset | |
| list | self, owner_principal_id, dataset | |
| download_path | self, payload_id, owner_principal_id, dataset | |
| recover | self | Call once at service startup. A live export's lock blocks recovery. |
| _cleanup | self, key | |
| prepare | self, document, dataset, owner_principal_id | |
| _build | self, record, records, files, allowance, imported_checks | |
| _documents_and_zip | stop, files, archive, manifest, allowance | |
| fraction | value | |
| write | name, text |
harness/verticals/retail/media_prepare.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, code | |
| validate | self | |
| _tree_bytes | root | |
| _kill_reap | process | |
| _run | argv, work, limits, deadline, stdout_limit | Bound pipes using files, enforce wall/output budgets, kill the whole group. |
| _probe | source, work, limits, deadline, frames | |
| _regular | path | |
| _hash_fd | fd | |
| _hash | path | |
| _number | value | |
| _dimensions | width, height, limits | |
| _source_metadata | probe, frame_probe, limits | |
| embedding_batches | clips | Match the existing Cosmos admission transport: 160 clips / 64 MiB. |
| prepare | asset_id, collection, source, output, limits | Return manifest after atomic publish to output/prepared. Caller owns tenancy. |
| main |
harness/verticals/retail/modal_embed.py
| Function | Arguments | Source description |
|---|---|---|
| _load_clips | paths | |
| _embed_batch | clips, queries, export_text | One remote input; imports and all model work stay inside the GPU worker. |
| init | self, bert, projection | |
| forward | self, input_ids, attention_mask | |
| _create_worker | modal, small_batch | |
| main | argv |
harness/verticals/retail/monitoring.py
| Function | Arguments | Source description |
|---|---|---|
| is_reference_event | value | |
| unique | self | |
| valid_geometry | self | |
| bounds | self | |
| init | self, state, source_lookup | |
| connect | self | |
| owner | owner | |
| register_source | self, owner, descriptor | Called by the host only after it verifies the imported bytes and routes. |
| registered_source | self, owner, key | |
| registered_sources | self, owner, dataset | |
| registered_datasets | self, owner | |
| save_profile | self, owner, definition, datasets, profile_id, expected_revision | |
| get_profile | self, owner, key, revision | |
| list_profiles | self, owner, dataset | |
| source | self, owner, key, dataset | |
| commit_event | self, owner, definition, origin | |
| list_events | self, owner, dataset, profile_ids, event_types, limit, after, exclude_ids, oldest_first, include_reference | |
| event_sources | self, owner | Each of the owner's events as (source, dataset, origin, review state), in one read. |
| get_event | self, owner, key | |
| validate_definition | self, definition | |
| events_for | self, definition | |
| readiness | self, definition | |
| resolve_monitoring_source | selected, owner, key, chat_id | Resolve current source and optional conversation grants before returning evidence. |
| available_monitoring_datasets | selected, owner | |
| monitoring_profile_authorized | selected, owner, record |
harness/verticals/retail/monitoring_routes.py
| Function | Arguments | Source description |
|---|---|---|
| phone_default | selected, record | Phone chat is a default capability of every Tracking Agent. |
| promotion | selected, chat_id, kind, definition, allow_active | |
| observation_detail | selected, record, reader, guards | |
| shown_presentation | selected, record, reader, guards | What a Tracking Agent's canvas draws beside its events, once its tracker has a record. |
| assembled | selected, record, tracker, page | A company tracker's row and canvas as the page would carry them now, from its stored output and readings. |
| published_page | state, owner | What the owner's published page holds of the company's own trackers, read once per version of the page: each tracker's tile row with its canvas, the page's currency and the location it shows. |
| register_monitoring_routes | app | |
| actor | request, write | |
| allowed | request, record, write | |
| execute | fn, *args, **kwargs | |
| execute_save | fn, *args, **kwargs | A person's save, answered in a person's words. A presentation someone saved in between answers 409, so the page reads it and sends the pick once more; a tracker still to get its location answers 409 too, and the page keeps what it holds; a canvas the output leaves unfilled answers the sentence its control shows. |
| profiles | request, dataset | |
| create_profile | body, request | |
| profile | profile_id, request, revision | |
| update_profile | profile_id, body, request | |
| events | request, dataset, profile_id, limit, after, evaluation | |
| event | event_id, request, evaluation | |
| commit_event | body, request | |
| observations | agent_id, request | |
| save_presentation | agent_id, body, request | A person's change of a Tracking Agent's tile or canvas: the same save as the harness's save_tracker_presentation. The agent's own record stays as it is, so a running agent keeps running. |
| promote | chat_id, body, request |
harness/verticals/retail/monitoring_tools.py
| Function | Arguments | Source description |
|---|---|---|
| tool | name, description, properties, required | |
| observation_specs | write | |
| specs | write | |
| scoped | store, index, host, chat_id | |
| lookup | owner, key | |
| family_of | name | |
| declared | family, name, args | A family tool's arguments, checked against the schema the tool itself declares. MCP checks them on its way in; the hosted chat hands them over as the model wrote them. |
| read | store, owner, dataset, name, args, agents | |
| admit_event_history | agent, chat_id, events | |
| _admit | family, agent, chat_id, scope, name, args, run, store, origin | What every family tool passes before its handler: a current member, the declared fields, and for a write the active parent conversation. Returns the handler's context and its arguments. |
| call_async | agent, chat_id, scope, name, args, run, index | A family write that waits on the event loop (ASYNC_NAMES): the checks of call, then the family's acall. The hosted conversation awaits it, so the wait holds no worker thread and follows the turn's stop. |
| admitted | ||
| call | agent, chat_id, scope, name, args, run, index | |
| tracker_specs | write | |
| _schedule | state, tracker, service | A location's schedule as a tool returns it; for one of the company's own trackers, its own automatic setting. service is the tracker service's note for this company: on, off, or waiting for its first sweep. |
| _run_rows | context, location_id, rows | A location's run rows for this reader. The counts a pass derived add up every camera of the location, so they are read with those cameras, like the outputs. |
| _run_of | run, key | One run as it concerns one tracker. |
| _script | context, row | A tracker's processing script as get_tracker returns it: the record's processor layer, and for a saved script its revision, policy, health and last test. |
| _trackers | context, location_id | The listing rows of list_monitoring_profiles, each with its schedule, output summary and last run. |
| place | key | |
| covered | key, cameras | |
| _other_installation | context, location_id, runs | A location the reader manages whose trackers run as another member, once that member's passes have stopped: the schedule and the last run of that installation, and the next step. |
| tracker_read | context, name, args | |
| readable | entry | |
| tracker_call | context, name, args | |
| present | *names | |
| registry | families | The read and the write names of every tool here, checked as the module loads. |
| observation_read | context, name, arguments | |
| observation_call | context, name, arguments |
harness/verticals/retail/mv3dt_dataset.py
| Function | Arguments | Source description |
|---|---|---|
| _identifier | value | |
| _number | value, minimum, maximum | |
| init | self, root | |
| remaining | self | |
| resolve | self, relative | |
| verify | self, reference, maximum | |
| receipt | self, reference, camera, kind | |
| _probe_bytes | command, timeout | Bound actual pipe reads, including malformed files with excessive video tracks. |
| probe_video | path, timeout | Read bounded MP4 metadata with ffprobe; this does not run a decoder/model. |
| compose_node | self, parent, index | |
| construct_mapping | self, node, deep | |
| _calibration | path, detector | |
| determinant | columns | |
| _clock | body, media, policy | |
| _frame_clock | body, media | Validate retained full-file probes; never synthesize timing from average FPS. |
| _qualification | files, request, pending | |
| preflight | dataset_root, request | Validate explicit host mappings; absent qualification evidence stays pending. |
| main |
harness/verticals/retail/playback_media.py
| Function | Arguments | Source description |
|---|---|---|
| safe_relative | self | |
| files | self | |
| unique_mappings | self | |
| init | self, state, owner | |
| catalog | self | |
| file | self, spec, kind | |
| sealed | self, specs | Each reference is a private, read-only regular file of its declared length. |
| resolver | request, context | |
| _catalog | request, context | |
| _match | artifact, binding | |
| _text | value, maximum | |
| _location | selected, context, catalog | The location record of this session's cameras, read through the company's own stores. |
| _error | exc, refused | Stable sanitized outcomes; the selected authority stays selected in every one. |
| maintained_bootstrap | request | |
| _admit | request, address | One complete decision: session identity, sealed catalog and current PostgreSQL lineage. |
| maintained_media | request, asset | |
| current | ||
| guarded |
harness/verticals/retail/presentation_captions.py
| Function | Arguments | Source description |
|---|---|---|
| enrich | agent, chat_id, run, collection, index, presentation | |
| current | ||
| emit | event |
harness/verticals/retail/qdrant_retrieval.py
| Function | Arguments | Source description |
|---|---|---|
| point_id | clip_id | |
| redirect_request | self, *args, **kwargs | |
| init | self, url, timeout | |
| request | self, method, path, body, allow_missing | |
| init | self, state, url, client | |
| publish_snapshot | cls, state, snapshot, client, promote | Publish a HOST-staged immutable snapshot without changing reader state. |
| _loaded_fingerprint | self | |
| _base_filter | self, fingerprint | |
| _publish_loaded | self, promote | |
| _check_source_generation | self | |
| refresh | self | |
| search_vector | self, vector, limit, dataset | Search a matching text vector; also allows isolated lookup benchmarking. |
| search | self, query, limit, dataset | |
| status | self | |
| main |
harness/verticals/retail/query_budget.py
| Function | Arguments | Source description |
|---|---|---|
| _now | ||
| _money | value | |
| init | self, approval_path, workspace | |
| _locked | self, planned | |
| _read_ledger | self | |
| _write_ledger | self, ledger | |
| _summary | ledger | |
| status | self | |
| reserve | self, planned_gross_usd, request_id | |
| _entry | ledger, reservation_id | |
| mark_started | self, reservation_id, resource_profile | |
| complete | self, reservation_id, runtime_estimate_usd, timing, billing_snapshot | |
| attach_app | self, reservation_id, app_id | Persist app identity before inference so failures can reconcile later. |
| fail | self, reservation_id, reason | |
| cancel_before_remote | self, reservation_id | |
| reconcile_modal | self, reservation_id, app_id | Autonomously reconcile using authenticated provider evidence. |
| reconcile_pending | self | Retry delayed provider reads automatically before later admissions. |
| _apply_provider_evidence | self, reservation_id, app_id, evidence | Pure accounting step; production evidence comes from Modal above. |
| reconcile | self, reservation_id, provider_evidence_path | Release unused credit only with a private, verified app-charge record. |
| _modal_app_evidence | workspace_name, app_id | Read provider state, current rates, and per-app costs without mutations. |
| read_app |
harness/verticals/retail/realtime_read_routes.py
| Function | Arguments | Source description |
|---|---|---|
| read_authority | environ | |
| _load_backend | Use the reviewed artifact closure, or the same checkout during development. | |
| maintained_lifespan | app | Open one restricted pool per service lifetime; startup never imports data. |
| _saved_company | selected | |
| _context | request | |
| register_realtime_read_routes | app, authority | |
| read | request, source_id, identity, at_s, epoch | |
| legacy_basket | request | |
| epoch_snapshot | request, source_id, epoch_id, at_s | |
| asset_snapshot | request, source_id, asset_id, at_s |
harness/verticals/retail/retail_agent_inputs.py
| Function | Arguments | Source description |
|---|---|---|
| validate_schedule | self | |
| inspection_ceiling | ||
| _capture_interval | source | Use only explicit imported wall-clock provenance, never file/index times. |
| timestamp | value | |
| evidence_scope | definition, sources, source_records, now | |
| init | self, monitoring, index, live_input_ready | |
| attach | self, store | |
| bind | self, index, live_input_ready | |
| normalize | self, record, table | |
| collection_allowed | self, spec, datasets, owner | |
| validate_definition | self, spec | |
| definition_context | self, agent, chat_id, arguments | |
| prepare_record | self, record, context | |
| runnable | self, record | |
| validate_activation | self, record | |
| resource_ceiling | self | |
| resource_allowance | self, definition | |
| validate_resource_budget | self, definition, runs | |
| resource_admitted | self, run | |
| describe | self, record, db | |
| recovered | self, db, run | |
| finished | self, db, run, status | |
| claimed | self, db, record, run | |
| prepare_screening | self, key, sources, source_records, now, force | |
| screening_failed | self, key, revision, error | |
| select | self, db, record, sources, source_records, screening, now, wake | |
| validate_wake | self, record, definition | |
| refresh | self, definitions | |
| sources | self, dataset | |
| ready | self, definition, wake, agent, input_optional | |
| prepare | self, definition, wake, agent | |
| execution | self, definition | |
| recurring_ready | self, collection, principal | |
| context | self, agent, run, snapshot |
harness/verticals/retail/retail_business.py
| Function | Arguments | Source description |
|---|---|---|
| safe_description | self | |
| init | self, state, index, collections | |
| _collection_exists | self, collection | |
| _initial | self, collection | |
| _present | self, record | |
| update_settings | self, collection, expected_revision, settings | |
| change | current, revision, timestamp | |
| save_connection | self, collection, body | |
| change | current, revision, timestamp | |
| install_business | selected | |
| register_routes | app | |
| business_settings | body, request | |
| business_connection | body, request |
harness/verticals/retail/retail_business_scope.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, state, company_id, member, members, source_authorized, clock | |
| _db | self, write | |
| _graph | db, collection | |
| _effective | self, actor, member, graph, revision, collection, locations | |
| effective | self, actor, collection, location_ids | |
| describe | self, actor, collection | |
| camera | self, actor, collection, camera_id, manage | |
| mutate | self, actor, collection, kind, value, expected_revision | |
| _event | self, db, collection, revision, actor, kind, record_id, value | |
| events | self, actor, collection, after, limit | |
| bind_chat | self, actor, chat_id, collection, location_ids, expected_revision, expected_selection_revision | |
| chat_scope | self, actor, chat_id, collection | |
| history | self, chat_id | |
| admit_history | self, actor, chat_id, scopes, source_ids, legacy | Bind all admitted context before any model/tool can expose it. |
| current | self, actor, collection, revision, account_role, chat_id, selection_revision | Cheap fail-closed fence for a previously admitted tool/media result. |
| legacy_scope_current | state, collection | Legacy local MCP has no live member resolver: configured scope uses HTTP. |
harness/verticals/retail/retail_dataset_reference.py
| Function | Arguments | Source description |
|---|---|---|
| associate_subject | metadata, view, mapping, tracks, start, end | |
| reference_windows | run_root, records, profile |
harness/verticals/retail/retail_demo_history.py
| Function | Arguments | Source description |
|---|---|---|
| event | person, kind, start, end, reference, item, where, evidence | One event with every field a Cosmos answer event carries. |
| visitor | rng, person, products, counter, hour | One visitor's events inside a recording, and the seconds the tracker sees them. |
| step | kind, seconds, reference, item, evidence, where | |
| take | ||
| tracker_frames | people, duration | Two frames per second; each visible person has one box that moves along the aisle. |
| plan | products, last_day, days, seed, last_day_until | The deterministic history: one entry per recording, oldest first. |
| generate | company, location_id, room_id, last_day, days, camera, seed, last_day_until | Write the planned history into the location through the ordinary ingestion. Safe to repeat. |
harness/verticals/retail/retail_host.py
| Function | Arguments | Source description |
|---|---|---|
| public_corpus | index | |
| init | self, host, selected | |
| participant_delivery_current | self, chat_id | |
| read_admission | self, actor, collection | |
| tool_context | self, context | |
| result_fields | self, name, content, success | |
| status_fields | self | |
| budget_fields | self | |
| member_cards | self, actor, collection, rows | |
| business_fields | self, actor, collection, value | |
| provider_usage | self | |
| available_credit | self | |
| agent_capabilities | self | |
| validate_activation | self, definition, once | |
| usage_fields | self | |
| authorize_file | self, request, file_id, principal | |
| file_download | self, record, principal | |
| plans | self | |
| public_clip | self, record | |
| inspection_metadata | self, record, frames, include_observations | |
| clip_attachments | self, ids, dataset | |
| connector_details | self, saved, connector_id, owner, collection | |
| connection_fields | self, value, principal, request | |
| catalogue | self | |
| draft_agent | self, template_id, collection, principal | |
| source_options | self, principal, collection | |
| request_scope | self, request | |
| tick | self | |
| close | self | |
| session_fields | self | |
| source_host | self | |
| source_store | self | |
| storage_runtime | self | |
| link_intake | self | |
| capabilities | self, collection, principal, chat_id, read_only, child, actor, custom | |
| install_workspace | host, selected | |
| monitoring_source | owner, key | |
| display_owner_agent | owner, collection, create | |
| collections | principal | |
| run_lane | run, depth | The lane of one run: the observation that woke it and the observations it was handed. |
| observation_lane | event, depth | 'live', 'replay' or 'unknown' for one committed observation, decided once and kept. |
| decide | ||
| chat_run_lane | chat_id | The lane of the host run active in this conversation; a person's own turn is live. |
| covers | definition, event | This saved definition tracks the observation: its business and its profiles. |
| tracker_alert | definition, event | Host alert delivery: the committed event is this Tracking Agent's processed alert, revision 1. |
| emit_monitoring_event | event | |
| phone_catch_up | Read again each covering observation of the last 900 seconds that holds no fan-out receipt. | |
| lifespan | app, host | |
| tick | ||
| register_routes | app, host, http | |
| public_request | request | |
| request_body_limit | request | |
| query_request | request | |
| scope_change | request | |
| local_services | *args, **kwargs | |
| read_workspace | host, selected | Install bounded retail reads without scheduler, messaging or runtime recovery. |
harness/verticals/retail/retail_http.py
| Function | Arguments | Source description |
|---|---|---|
| web_asset | relative | |
| register_routes | app, host, http | |
| search | request | |
| review_cameras | body, request | |
| run_review | ||
| source_frames_only | maximum | |
| prepare_export | body, request | |
| export_scope_allowed | request, payload_id, principal | |
| require_export_scope | request, payload_id, principal | |
| list_exports | request, dataset | |
| inspection_preview | receipt_id, index, request | |
| unavailable | ||
| get_export | payload_id, request | |
| download_export | payload_id, request | |
| cameras | request, collection | |
| camera_details | camera_id, request, collection | |
| camera_context_draft | camera_id, body, request, collection | |
| confirm_camera_context | camera_id, body, request, collection | |
| source_library | request, collection, folder | |
| source_asset | asset_id, request, collection | |
| visible_clip | request, clip_id | |
| evidence_clip | clip_id, request | |
| thumbnail | clip_id, request | |
| download_clip | clip_id, request | |
| clip_manifest | record, resolved, source_cut_available | |
| clip_focus | state, clip_id, focus_id | |
| download_manifest | clip_id, request, focus_id | |
| clip_details | clip_id, request, focus_id | |
| file_authorization | request, file_id, principal | |
| original_source | asset_id, request, collection | |
| sij_acroni_logo | ||
| control_room_script | ||
| camera_provider_asset | filename | |
| retail_scope_component | request | |
| retail_component | request |
harness/verticals/retail/retail_mcp_services.py
| Function | Arguments | Source description |
|---|---|---|
| local_services | state, principal_id, dataset, derivatives_enabled, index_factory | |
| local_result | name, value | |
| local_authority | self, actor, collection | |
| collection_names | self, principal | |
| local_read_names | self | |
| read_admission | self, actor, collection | |
| bind |
harness/verticals/retail/retail_records.py
| Function | Arguments | Source description |
|---|---|---|
| post_init | self | |
| display_owner_agent | self, create | Actual agent identity supplied by the host; legacy data keeps its principal owner. |
| id | self | |
| actor | self | |
| open_company | state, owner, collection, member | Open a company's stores. member(principal) is the host's membership lookup. |
| company_from_access | state, access_state, environment_id, owner, collection | Open a company through its access registry, as the host commands do. |
| member | principal | |
| digest | value, length | |
| rows | company, kind, location_id | |
| stamp | company, location_id, value, camera_id | |
| put_many | company, kind, location_id, values, replace_all, keep | One transaction per kind. replace_all rebuilds a derived kind for the location. |
| cameras | company, location_id | |
| ensure_camera | company, location_id, room_id, name, source_ids | Create the named camera in the location, or add recordings to it. One scope write. |
| register_zone | company, location_id, camera_id, key, kind, label, data_basis | |
| source_clocks | company | Capture start (epoch seconds) of each registered recording that has one. |
| iso | epoch | |
| record_till_sales | company, location_id, transactions | Write till transactions into the same sale tables with basis: "pos". |
| catalog | company, location_id | Catalog products of the location: the ones a catalog source or the finder supplied. |
| derive | company, location_id | Accumulate committed events into items, baskets, estimated sales, shelves and queues. |
| line | entry |
harness/verticals/retail/retail_scope.py
| Function | Arguments | Source description |
|---|---|---|
| install_scope | selected, messaging_member, members | Callbacks: member(selected, principal), members(selected), both current. |
| source_authorized | actor, collection, source | |
| _owned_views | selected, principal, collection | |
| filter_view | selected, view, principal, collection, chat_id, observer | Return an immutable narrowed index with a synchronous current() fence. |
| public_revisions | ||
| public_current | ||
| shared_collections | ||
| current | ||
| scope_current | view | Explicitly fail closed for unbound/invalid views at host dispatch seams. |
| history_allowed | selected, record, principal | Whole-chat admission: historical context never widens current membership. |
| turn_actor | agent, chat_id, sender | |
| agent_scope | agent, chat_id, dataset, sender, admit | Fresh tool authority, cumulative history admission and native isolation. |
| read | function, *args, **kwargs | |
| active_scope_current | agent, chat_id | |
| history_within_view | selected, record, view | Old derived files/context require the whole admitted historical scope. |
| init | self, selected | |
| history_allowed | self, record, principal | |
| filter_view | self, view, principal, collection, chat_id, observer | |
| owned_views | self, principal, collection | |
| history_within_view | self, record, view | |
| source_options | self, principal, collection | |
| agent_scope | self, agent, chat_id, dataset, sender, admit | |
| request_scope | self, request | |
| bind | self, view | |
| bound |
harness/verticals/retail/retail_scope_routes.py
| Function | Arguments | Source description |
|---|---|---|
| call | callback, *args, **kwargs | |
| body | request, fields | |
| pairs | items | |
| result | function, *args, **kwargs | |
| register_scope_routes | app, store_for_workspace, actor_for_request, collection_for_request, chat_for_request, describe_for_request | |
| selected | request, collection, write | |
| graph | request, collection | |
| graph_events | request, collection, after, limit | |
| change | kind, request | |
| chat_scope | chat_id, request | |
| change_chat_scope | chat_id, request | |
| register_host_routes | app | Register private graph/selector APIs using the host's current session ACL. |
| actor | request, write | |
| collection | request, value | |
| chat | request, key, write | |
| describe | request, value |
harness/verticals/retail/retail_scope_views.py
| Function | Arguments | Source description |
|---|---|---|
| scoped_index_view | index, effective | Narrow an ALREADY owner/Ready-filtered index; this never grants ownership. |
| selected_index_view | index, positions | Copy already-admitted row positions and rebuild the aligned public index. |
harness/verticals/retail/retail_script_signals.py
| Function | Arguments | Source description |
|---|---|---|
| digest | value | |
| init | self, store, company, sandbox, clock | |
| _snapshot | self, record | |
| _save | self, company, tracker, value | |
| save | head, put | |
| _update | self, record, **changes | |
| authorized | self, record | |
| processor | self, tracker, company, location_id, period, data | |
| execute | self, company, tracker, document, source, context, perform, current | |
| run | self, payload, config, context | |
| cancel | self, context | |
| _cleanup | self, context | |
| recover_pending | self | Settle interrupted original jobs before another location pass is admitted. |
| reconcile | self, context | |
| init | self, adapter, signal | |
| opened | self, job | |
| closed | self, job | |
| before_publish | self | |
| delivery | self, wanted, text | |
| install | selected | Register against the actual host store so later delivery retains producer authority. |
| company | owner, collection | |
| processor | app_state, sandbox | |
| run | tracker, company, location_id, period, data |
harness/verticals/retail/retail_settings.py
| Function | Arguments | Source description |
|---|---|---|
| value | name, default, environ | |
| remove | name, environ |
harness/verticals/retail/retail_stream_import.py
| Function | Arguments | Source description |
|---|---|---|
| load | path | |
| timestamp | value | |
| final_events | text | |
| event_key | source_id, output_index, event_index, raw | |
| audit_event | raw, source_id, output_index, event_index, start_s, end_s, observed_start_s, observed_end_s, tracks, profile_id, profile_revision, review, vocabulary | |
| build_import | run_root, profile_id, profile_revision, reviews, vocabulary | |
| main |
harness/verticals/retail/retail_tool_context.py
| Function | Arguments | Source description |
|---|---|---|
| state | self | |
| allowed | self, location_id, camera_ids | Whether the reader's present access covers a location and, with camera_ids, those cameras of it. A tracker's definition belongs to its location; its output is the record of the cameras it read, so an output is read with its own cameras. |
| manages | self, location_id | Whether the reader manages a location in the scope this read arrived with. |
| source | self, source_id | Whether the reader's present access covers a recording. |
| require | self, location_id | |
| organization | self | Whether this is the company's Organization conversation. |
| company | self | The acting member's handle on the company's stores, under the host's current scope. |
harness/verticals/retail/retail_tools.py
| Function | Arguments | Source description |
|---|---|---|
| bridge_specs | write | |
| result_fields | name, content, success | |
| bridge_call | context, name, args | |
| preview_current | ||
| plans | self | |
| public_clip | record | |
| inspection_metadata | self, record, frames, include_observations | |
| clip_attachments | self, ids, dataset | |
| context | admitted | |
| catalog_call | context, name, arguments | |
| connector_details | agent, saved, connector_id, owner, collection | |
| external_read | context, name, arguments | |
| local_call | context, name, arguments |
harness/verticals/retail/retail_urls.py
| Function | Arguments | Source description |
|---|---|---|
| legacy_path | path, method | Classify current paths through their established admission policy. |
| init | self, app | |
| getattr | self, name | |
| register | path, **options | |
| decorate | endpoint | |
| retail_router | app |
harness/verticals/retail/retail_usage.py
| Function | Arguments | Source description |
|---|---|---|
| read | self, approval_path | |
| validate | self, path |
harness/verticals/retail/retired_tools.py
| Function | Arguments | Source description |
|---|---|---|
| require_active_tool | name | |
| active_specs | specs | |
| is_retired_archive_agent | definition | Saved camera_footage scheduler definitions use the retired archive workflow. |
harness/verticals/retail/retrieval.py
| Function | Arguments | Source description |
|---|---|---|
| _slug | value | |
| load_sources | sources, manifests | Read local paths only. Descriptions in manifests never become embeddings. |
| init | self, state | |
| _reload | self | |
| _load_model | self | |
| _encode_images | self, images | |
| _encode_text | self, query | |
| build | self, sources, interval | |
| search | self, query, limit, dataset | |
| get_clip | self, clip_id | Private server lookup; includes filesystem paths, never a public API body. |
| get_video | self, video_id | Private server lookup for controlled media serving. |
| inspect_clip | self, clip_id | Decode up to three frames for the agent to inspect; makes no verdict. |
| status | self | |
| main |
harness/verticals/retail/run_stock_commissioning.py
| Function | Arguments | Source description |
|---|---|---|
| probe_clock | path | CPU-only decoder preflight before importing vLLM or creating a model. |
| capture | pad, info, target | |
| main | ||
| result | element, sid, start, end, text | |
| message | bus, msg | |
| tick |
harness/verticals/retail/seal_playback_media.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, code, message | |
| unique_views | self | |
| _sha | content | |
| _open_evidence | path | |
| _chunks | source | |
| _measure | path, maximum, code | SHA-256 and length of one file, read once within the bound of its kind. |
| _content | path, maximum, code | |
| _resolve | root, value | |
| load_selection | path | |
| selection_from_import | path, face_redaction | Every view of one completed historical import, in the importer's own identifiers. |
| _boxes | data, start, end | |
| _one | data, bounds, kind | |
| _movie_header | path | |
| probe_recording | path | Width, height, frame count and constant frame rate of the one video track of an MP4. |
| sidecar_digest | items | One digest for a per-frame KITTI directory: the sorted listing of each file's hash and name. |
| read_tracker_sidecar | directory, frame_count | Every reported box of every frame, and each raw tracker ID's first reported frame. |
| geometry_document | recording, source_sha256, tracker_namespace, frames, births | What the player paints from: one entry per frame, each box with its ID and birth identity. |
| _context | company_id, principal_id | |
| _lineage | selection | The current binding of every selected recording, and each tracker epoch's visitors. |
| reported_births | view, binding, recording, first, sidecar_sha256, visitors | Each raw tracker ID's reported birth identity, proven equal to the one PostgreSQL holds. |
| _service_identity | state | The service identity owns the private state and runs this command; the reader requires both. |
| _private_directory | path | True for a private real directory of this identity, False for an absent one. |
| _sealed | path, sha256, size | True for an intact sealed file, False for an absent one; any other state is refused. |
| plan | options | Verify the whole selection and describe the sealed catalog. This writes nothing. |
| place | kind, sha256, size, source | |
| _write | target, sha256, size, source, replace | One sealed regular file of its own bytes: written beside its name, checked, then named. |
| _sync | path | |
| seal | planned, prune | Copy, check through the reader's own code, then replace the catalog in one rename. |
| _reserve | path | |
| run | options | The dry run or the real seal over an open restricted pool; returns the receipt. |
| run_with_database | options, dsn | Open the one restricted pool this command reads through, seal, and close the pool. |
| parser | ||
| main | argv, environ |
harness/verticals/retail/seed_control_room.py
| Function | Arguments | Source description |
|---|---|---|
| seed_location | state, access_path, environment_id, owner, lifecycle, collection, name, address, cover_image, coordinates | |
| member | key |
harness/verticals/retail/seed_retail_demo.py
| Function | Arguments | Source description |
|---|---|---|
| seed_day | company, requested | The day the preserved clips sit on: the one already registered, else the requested or latest full day. |
| seed | state, access_state, environment_id, owner, lifecycle, archive, found_products, day, history_days, product_types_output, collection, name, address, coordinates, publish_media | |
| main | argv |
harness/verticals/retail/sftp_intake.py
| Function | Arguments | Source description |
|---|---|---|
| drain | task | |
| offload | fn, *args, **kwargs | |
| callback | fn, *args, **kwargs | |
| init | self, store | |
| db | self | |
| bind | self, config | |
| status | self, config | |
| scan | self, config, page, cursor, now | |
| rows | self, config | |
| cursor | self, config | |
| block | self, config, name | |
| missing | self, config, name | |
| reset | self, config, name, now | |
| upload | self, config, name, upload | |
| sealed | self, config, name, upload, now | |
| finish | self, config, now, error | |
| init | self, store, connector, clock, max_active, begin_upload | |
| _owned | self, config, actor | |
| status | self, config, actor | |
| pull | self, config, actor, credentials, current, cancelled, max_seconds | |
| alive | ||
| watch | ||
| _pull | self, config, actor, credentials, current, seconds | |
| _acquire | self, config, actor, row, item, reader, current | |
| stop | self, config, actor | |
| close | self |
harness/verticals/retail/sftp_transport.py
| Function | Arguments | Source description |
|---|---|---|
| require | value, code | |
| digest | value | |
| text | value, maximum | |
| validate_target | value | |
| post_init | self | |
| sha256 | self | |
| target_sha256 | self | |
| fingerprint | self | |
| post_init | self | |
| from_attrs | cls, name, attrs | |
| version | self | |
| public_socket | config, current | |
| init | self, config, client, current, private_values | |
| metadata | self, value | |
| check | self | |
| path | self, name | |
| list_page | self, cursor, limit | |
| open | self, expected | |
| read | self, handle, offset, length | |
| connect | config, credentials, current, socket_factory | socket_factory is host-only fixture injection, never a serialized setting. |
harness/verticals/retail/shelf_catalog.py
| Function | Arguments | Source description |
|---|---|---|
| valid_box | self | |
| init | self, state, setup, locations, provider, enabled, funding_ready, clock | |
| connect | self | |
| _status | self, owner, photo, status, detail | |
| process | self, owner, photo_id | |
| drain | self, limit | |
| image | self, owner, key, index |
harness/verticals/retail/source_derivatives.py
| Function | Arguments | Source description |
|---|---|---|
| _json | value, maximum | |
| _digest | value | |
| _require | value, code | |
| init | self, state, company_id, media_client, enabled | |
| _authorize | self, record, owner, purpose, frame_seconds | |
| _published | self, asset_id, owner | |
| _initialize | self | |
| _db | self, write | |
| _row | self, identity, key | |
| _admit | self, record, binding | |
| _update | self, identity, expected_generation, **fields | |
| _locked | self, identity | |
| _scope | self, row, binding | |
| _validate_files | self, manifest, files, binding, scope | |
| read_receipt | self, receipt_id, record, owner_principal_id, purpose | |
| _read_receipt | self, receipt_id, record, owner_principal_id, purpose | |
| _read | self, row, record, owner, purpose | |
| derive | self, record, purpose, owner_principal_id, frame_seconds | |
| _derive | self, record, purpose, owner_principal_id, frame_seconds | |
| _cleanup | self, row, binding, handle | |
| _reconcile | self, row, binding | |
| _receive | self, row, binding, handle, result | |
| _run | self, row, record, binding, resolved |
harness/verticals/retail/source_embedding.py
| Function | Arguments | Source description |
|---|---|---|
| require | ok, code | |
| encode | value | |
| checksum | data | |
| private_directory | path | |
| fsync_directory | path | |
| atomic_json | path, value | |
| read_private | path, maximum | |
| read_json | path | |
| locked | path | |
| utc | ||
| runtime | python, config | |
| implementation_identity | ||
| batch_identity | context, batch, company, idempotency_key, profile | |
| public | record | |
| drain | task | |
| owned_thread | function, *args | |
| init | self, state, company_id, approval_path, modal_python, modal_config, profile, runner | |
| admit | self, context, batch, idempotency_key | |
| _admit | self, context, batch, idempotency_key | |
| _directory | self, admission | |
| _stage | self, directory, record, inputs | |
| run | self, admission, inputs, cancelled | |
| stop | self, admission | Host-only crash reconciliation; leaves the full budget hold intact. |
| receipt | self, admission | Host-only audit; approval paths/identities are never an HTTP response. |
| validate_result | result, record | |
| init | self, python, config | |
| _stop | self, directory, interpreter, environment | |
| stop_attempt | self, directory, record | |
| run | self, directory, record, cancelled | |
| cleanup | ||
| verify_workspace | modal | |
| app_name | record | |
| provider_update | directory, record, **values | |
| stop_own_app | modal, directory, record, timeout_seconds | Verify this exact attempt's app and wait for provider-confirmed absence. |
| stop | ||
| verified_info | ||
| child_record | directory | |
| child_run | directory, modal_module, worker_factory, stop_function | |
| watch_app | ||
| child_stop | directory | |
| main | ||
| interrupted | signum, frame |
harness/verticals/retail/source_intake.py
| Function | Arguments | Source description |
|---|---|---|
| _text | value, maximum | |
| _sha | value | |
| _integer | value, lower, upper | |
| post_init | self | |
| require_write | self | |
| post_init | self | |
| post_init | self | |
| init | self, company_state, limits, clock | |
| _directory | path | |
| _open | path, flags, mode | |
| _connect | self | |
| _write | self, current | |
| _read | self | |
| _writer | actor | |
| _owned | db, table, identity, actor | |
| _sync_directory | path | |
| _public_upload | row | |
| _public_job | row | |
| create_source | self, actor, collection, name, kind | |
| lookup_connection_source | self, actor, collection, connection_id, target_sha256 | |
| ensure_connection_source | self, actor, collection, connection_id, target_sha256, name, kind, current | Host connection identity maps retries to one owner-scoped source. |
| get_source | self, actor, source_id | |
| ensure_upload_source | self, actor, collection | Host-validated collection; one durable default per uploader/collection. |
| list_sources | self, actor, collection | |
| _import_view | cls, db, row | |
| get_import | self, actor, upload_id | |
| list_imports | self, actor, collection, limit, offset | |
| cancel_import | self, actor, upload_id | Fence acquisition and every unfinished stage in one transaction. |
| _quota | self, db | |
| begin_upload | self, actor, source_id, filename, size, idempotency_key, object_key, source_version, current | |
| get_upload | self, actor, upload_id | |
| _upload_file | self, row | |
| append_chunk | self, actor, upload_id, offset, data, sha256, current | |
| append_stream | self, actor, upload_id, offset, size, stream, sha256, current | Read one bounded chunk, with at most 64 KiB in the copy buffer. |
| seal_upload | self, actor, upload_id, expected_sha256, current | |
| _verify_blob | self, path, size, checksum | |
| _finish_seal | self, db, row | |
| cancel_upload | self, actor, upload_id | |
| get_asset | self, actor, asset_id | |
| list_uploads | self, actor, source_id | |
| _queue_job | self, db, asset_id, stage | |
| _result | value | |
| _event | self, db, row, kind, body | |
| _expire_jobs | self, db | |
| claim_job | self, worker_id, lease_seconds, stages, asset_id | Host worker only. Expired attempts require explicit reconciliation. |
| _leased | self, db, lease | |
| heartbeat_job | self, lease, lease_seconds | |
| job_context | self, lease | Private worker input, including durable evidence from earlier stages. |
| checkpoint_job | self, lease, checkpoint | Private host attempt identity before work; never a completion receipt. |
| open_job_original | self, lease | Host worker gets a verified read-only descriptor, never a public host path. |
| finish_job | self, lease, result | Result is trusted worker evidence, not model/browser-supplied metadata. |
| _finish_job_locked | self, db, row, result | |
| finish_publication | self, lease, publish | Fence bounded local publication and its Ready receipt together. |
| fail_job | self, lease, error_code, uncertain | |
| cancel_job | self, actor, job_id | |
| reconcile_job | self, job_id, expected_generation, outcome, evidence_reference | Trusted worker/operator settles uncertain work after actual stop/billing checks. |
| recover | self | Reconcile local transfer crashes; uncertain running jobs remain fenced. |
harness/verticals/retail/source_routes.py
| Function | Arguments | Source description |
|---|---|---|
| post_init | self | |
| _deny | status, code | |
| _header | request, name, required | |
| _number_header | request, name, maximum, required | |
| _encoding | request | |
| _offload | function, *args, **kwargs | Keep private streams open until their finite disk transaction finishes. |
| _call | function, *args, **kwargs | |
| _duplicates | pairs | |
| _json_body | request, model, policy, empty | |
| register_source_routes | app, store_for_workspace, policy_for_workspace, admission_for_workspace, projection_for_workspace | Register once after the host's authenticated workspace middleware. |
| context | request, write, continuation, projected | |
| collection | value, allowed | |
| view_for | store, actor, identity, allowed | |
| response | view, store, status_code | |
| imports | request | |
| begin | request | |
| detail | upload_id, request | |
| content | upload_id, request | |
| complete | upload_id, request | |
| cancel | upload_id, request | |
| sources | request | |
| add_source | request | |
| source | source_id, request |
harness/verticals/retail/source_service.py
| Function | Arguments | Source description |
|---|---|---|
| code_identity | Bind readiness to the worker's local source closure, including paid admission. | |
| digest | value | |
| require | ok, code | |
| private_dir | path | |
| read | path, uid, public | |
| lock | path, exclusive | |
| load | cls, state, company | |
| fingerprint | self | |
| init | self, state, company_id, clock, read_only | |
| configuration | self | |
| code_current | self | |
| records | self | |
| save | self, record | |
| healthy | self, config | |
| policy | self | |
| approval | self, config | |
| collections | self, actor | |
| readiness | self, actor, collection | Safe observed admission state; continuation survives config removal. |
| capabilities | self, actor | |
| begin_remote | self, store, actor, source_id, filename, size, idempotency_key, object_key, source_version, current | Host callback for fixed storage readers; reserve the ordinary file allowance. |
| begin | self, store, actor, collection, filename, size, idempotency_key, source_id, current, _remote | |
| _bind | self, store, record, current | |
| authorize | self, actor, view, operation | |
| recover_admissions | self, store | |
| root_bytes | path, expected_uid | |
| init | self, host, config, media, qdrant, receipt_path, root_reader | |
| installed | self | |
| call | self | |
| init | self, host, store, worker, probe, sleep_seconds | |
| write_health | self | |
| pulse | self | |
| _jobs | self | |
| _attempts | self, job | |
| reconcile | self | Stop stale owned effects; retries and financial holds remain explicit. |
| step | self | |
| run | self | |
| main_async | state | |
| main |
harness/verticals/retail/source_visibility.py
| Function | Arguments | Source description |
|---|---|---|
| _imported | row | |
| _receipt | value | |
| _authority | store, principal, asset_ids | One source-store read snapshot; no index lock or media decoder is held. |
| _allowed | row, authority, store | |
| _report | rows, original | |
| _read_only | *args, **kwargs | |
| ready_index_view | index, store, principal_id | Capture one principal's coherent read-only view without changing the index. |
| init | self, index, company_state | |
| _store | self | |
| snapshot | self, principal_id, source, refresh, apply_scope | |
| bind | self, view, check_exit | |
| current | self | |
| refresh | self | |
| copy | self | |
| getattr | self, name | |
| chat_source_view | index, principal_id | Bind saved chat ownership and preserve any narrower native/scheduler view. |
harness/verticals/retail/source_worker.py
| Function | Arguments | Source description |
|---|---|---|
| post_init | self | |
| _thread | function, *args, **kwargs | |
| _settle | awaitable | Finish finite cleanup despite another cancellation of its owner. |
| _original | store, lease | |
| _hash | path | |
| _finite | value, low, high | |
| _regular | path | |
| _directory | path | |
| _fsync_dir | path | |
| validate_manifest | value, context, recipe | Verify source binding, bounded numeric claims and the exact file catalogue. |
| init | self, store, limits | |
| acquire | self, size, entries | |
| stage | self, asset_id, label | |
| allocation | self, size, entries | |
| load | self, asset_id, receipt | |
| seal | identity, path | |
| init | self, client, deadline | |
| request | self, *args, **kwargs | |
| init | self, state, resolver_ready, client, seconds | |
| publish | self, records, vectors, metadata | |
| before_commit | snapshot, promote | |
| init | self, store, company_id, media_client, media_image, embedding_adapter, publisher, enabled, limits, scope_factory | |
| checkpoint | self, lease, **body | |
| run_once | self, worker_id, stages, asset_id | |
| heartbeat | ||
| _scope | self, context, lease | |
| prepare | self, lease, context, stop | |
| receive_prepared | self, lease, context, scope, handle, result | |
| prepared | self, context | |
| embed | self, lease, context, stop | |
| records | self, context | |
| publish | self, lease, context |
harness/verticals/retail/stock_commissioning.py
| Function | Arguments | Source description |
|---|---|---|
| canonical | value | |
| digest | value | |
| file_sha | path | |
| load | path, limit | |
| save | path, value, immutable | |
| finite | value | |
| result_key | stream_id, start, end | |
| verify_prepared | row | |
| sampling_recipe | name, requested | Reject unsupported/different settings; never silently drop a recipe knob. |
| sampling_evidence | params | Snapshot actual vLLM object attributes, including defaults not forwarded. |
| reasoning_prompt | prepared | Keep the business schema and host binding; append only the user directive. |
| clock_receipt | model_input_sha256, encoded_pts, decoded_pts, running_pts, segments | Verify actual before/after identity probes against encoded presentation PTS. |
| finite_segment_preflight | clock, segment_seconds | Stock finalizes at current_pts-1ns; an endpoint frame alone cannot flush. |
| build_config | rows, base, prepared, recipe_name, segment_seconds | |
| init | self, folder, prepared, plans, clocks, recipe_name | |
| receive | self, kind, value | |
| reject | self, key, reason | |
| validate_supervisor | receipt, worker_pid, worker_pgid, worker_sid, parent_pid, parent_pgid, deadline_epoch, manifest_sha256 | Require an explicit host-owned teardown contract for this isolated worker. |
harness/verticals/retail/stock_commissioning_observer.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, folder, prepared, joiner | |
| simple | self, v | |
| hook | self, frame, event, arg | |
| safe_hook | self, frame, event, arg | |
| install | self |
harness/verticals/retail/stock_supervisor.py
| Function | Arguments | Source description |
|---|---|---|
| _prctl | option, arg | |
| install_group_filter | Called only inside the isolated child, before the worker can fork. | |
| _private_json | path, expected_sha | |
| validate_provider_reference | path, expected_sha, deadline_epoch, manifest_sha256, now | Validate a prior host attestation's binding, not the remote provider state. |
| _group_signal | pid, signum | |
| _group_present | pid | |
| _gated_worker | gate, ready, parent_pid, command | |
| supervise | command, manifest, output, deadline_epoch, provider_receipt, provider_sha256, max_log_bytes | Host-only launch primitive; CLI below pins command to the stock runner. |
| main |
harness/verticals/retail/storage_connections.py
| Function | Arguments | Source description |
|---|---|---|
| initialize_schema | db | |
| public_values | db, key | |
| _grant | db, key | |
| validate_target | target, declared | |
| metadata | self | |
| config | self | |
| sha256 | self | |
| init | self, store, sources | |
| _owned | self, db, key, owner, collection | |
| propose | self, key, target, reason, expected_revision, owner, collection | |
| approve | self, key, proposal_id, owner, collection | |
| pause | self, key, expected_generation, owner, collection | |
| describe | self, key, owner, collection | |
| _binding | self, db, key, owner, collection | |
| snapshot | self, key, owner, collection | |
| _current | self, db, snapshot | |
| current | self, snapshot | Read-only, zero-busy probe for the transport's event-loop guard. |
| credentials | self, snapshot |
harness/verticals/retail/storage_routes.py
| Function | Arguments | Source description |
|---|---|---|
| register_storage_routes | app, identity, runtime_for_workspace, owner_for_connector | |
| selected | request, key, write | |
| public | value, request | |
| status | connector_id, request | |
| approve | connector_id, request | |
| run | connector_id, request | |
| pause | connector_id, request |
harness/verticals/retail/storage_runtime.py
| Function | Arguments | Source description |
|---|---|---|
| code_identity | ||
| load | cls, state | |
| sha256 | self | |
| init | self, state | |
| db | self | |
| get | self, key, owner, collection | |
| records | self | |
| request | self, snapshot | |
| stop_intent | self, key, owner, collection | |
| lock | self, key | |
| current | self, row | |
| update | self, row, status, cleanup, error, retire | |
| reconcile | self, row | |
| init | self, authority, source_host, clock, access_state, environment | |
| healthy | self | |
| member_current | self, owner | |
| current | self, snapshot | |
| _source | self, key, value, owner, collection | |
| funded | self, owner, collection, source | |
| describe | self, key, owner, collection | |
| fingerprint | key | |
| approve | self, key, proposal_id, owner, collection | |
| run | self, key, owner, collection, expected_generation | |
| request | ||
| pause | self, key, owner, collection, expected_generation, timeout | |
| revoke |
harness/verticals/retail/storage_service.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, runtime, acquirer, tick_seconds | |
| configured | self | |
| health | self | |
| pulse | self | |
| acquire | self, row | |
| current | ||
| step | self | |
| run | self | |
| main_async | state | |
| main |
harness/verticals/retail/stream_ingestion.py
| Function | Arguments | Source description |
|---|---|---|
| canonical | value | |
| explicit_association | self | |
| intervals | self | |
| init | self, state, monitoring, clock | |
| connect | self | |
| _authorize | self, owner, spec | |
| accept_model_response | self, owner, context, raw_response, adapter_receipt | Host adapter for the actual JSON response, without model-supplied trust flags. |
| model_claim | self, owner, event_id | Read a committed claim with current source authorization and exact raw bytes. |
| accept | self, owner, window, _model_response, _adapter_receipt | Recoverable inbox → immutable events → durable downstream work. |
| history | self, owner, stream_id, limit | |
| drain | self, owner, handlers, limit | Run bounded host handlers; failed remote work stays explicit for review. |
harness/verticals/retail/stream_runtime.py
| Function | Arguments | Source description |
|---|---|---|
| setup_catalog_inspection | selected | |
| authorized | owner, event | |
| resolve | owner, source_id | |
| setup_shelf_catalog | selected | Explicit commissioning plus per-photo consent precede paid photo egress. |
| funded | ||
| drain_stream | selected | |
| stream_tick | selected |
harness/verticals/retail/tracker_presentation.py
| Function | Arguments | Source description |
|---|---|---|
| specs | write | |
| tracker_of | state, owner, collection, tracker_id | The tracker record an id names: the record's own id, or the id of its Tracking Agent. |
| agent_tracker_record | company, agent, change, profiles, expected_revision, allowed | The tracker record a save for a Tracking Agent writes to. |
| describe | state, owner, collection, tracker, covered, revision | What get_tracker_presentation answers for one tracker record. |
| save | company, tracker, change, expected_revision, saved_by | Save a tracker's presentation and carry it into the published page. One function for the harness tool and for a person's route. |
| read | context, name, args | |
| call | context, name, args | |
| _profiles | monitoring, owner, agent | |
| save_for_agent | selected, agent, change, expected_revision | A person's save for a Tracking Agent's tracker, from the host's own stores. |
harness/verticals/retail/tracker_runner.py
| Function | Arguments | Source description |
|---|---|---|
| canonical | value | |
| digest | value | |
| iso | epoch | |
| read_only | path | A read-only connection to a company store, or None while the store has no file yet. |
| engine_sources | Every file that decides what a pass computes: the recipe, its processors, the accumulation step, the basket reducer, the product types and the page publisher. | |
| engine_revision | sources | The revision of the maintained code this process runs a pass with. A release that changes any of it moves every location's stamp, so each location recomputes once. |
| installed_locations | state | Every (owner, collection, location) of this company that has installed trackers. |
| input_stamp | state, owner, collection, location_id | A stamp of everything a pass reads for one location. It moves when an input row is added, rewritten or removed, when the location's place in the company changes, and with a new revision of the maintained processors. What a pass writes itself (derived rows, outputs) stays out. |
| scope_revision | state, collection | The revision of the collection's place graph: its locations, rooms, cameras and members. |
| script_wake_authorizer | selected | Bind the retail script signal's authority to this workspace's current stores. |
| authorize | definition, wake, admit | |
| location_cameras | state, collection, location_id | Every camera the place graph has at a location: the cameras whose rows a pass reads. |
| projection_pending | state, owner | How many of the owner's queued stream projections wait to reach the location store. |
| drain_projections | company, limit | Bring the owner's queued projections into the location store, oldest first; returns how many. |
| commit_count | state, owner | How many observations the owner has committed. The commit store only ever grows. |
| committed_after | state, owner, collection, cursor, limit | The owner's committed observations of a collection past a cursor, in the order they were committed: [(position, observation)]. The position is the commit store's own row number, which only grows, so a commit is read once whatever the host clock said when it was made. |
| committed_events | state, owner, event_ids | The owner's committed observations with these ids, in commit order. |
| saved_zone | state, owner, location_id | The timezone of the location's saved coordinates, when it has them. |
| current_outputs | state, owner, collection, location_id | The current output of each tracker the owner has: its tile, canvas and revision. |
| output_cameras | state, owner, collection, location_id | Every camera the location's current outputs read, without their tiles and canvases. |
| output_revisions | state, owner, location_id | Each current output's tracker key, location and revision, read without its tile and canvas. |
| prune_output_revisions | company, location_id, keep | Keep each tracker's newest output revisions at a location; returns how many rows went. The current output is a row of its own and stays whole. |
| page_directory | state, owner | |
| page_location | state, owner | The location the owner's published page shows, once a host import has published one. |
| page_digest | state, owner | The sha256 of the owner's page data as it is published now, read once per file version. |
| ledger_mark | state | A mark that moves with every write to the company's run ledger: one file stat. |
| clean_policy | value | A location's run policy, checked: the fields set_tracker_schedule writes. |
| init | self, state, clock | |
| connect | self, write | |
| state | self, owner, collection, location_id, **options | |
| policy | self, owner, collection, location_id, **options | |
| set_policy | self, owner, collection, location_id, changes, **options | |
| request | self, owner, collection, location_id, **options | |
| pending_location_jobs | self, owner, collection, location_id | An admitted signal job retains its location until original cleanup confirms. |
| claim | self, owner, collection, location_id, **options | |
| finish | self, run_id, lease_token, **options | |
| reap | self, owner, collection, location_id, **options | |
| record | self, owner, collection, location_id, **options | |
| runs | self, owner, collection, location_id, **options | |
| forget_tracker | self, owner, collection, location_id, key | |
| job_open | self, job, owner, collection, location_id, tracker_id | |
| last_run | self, owner, location_id | |
| projection | self, owner, collection | Where the reading of the owner's commits stands: how many commits were counted, the position of the last one read, the place graph's revision at that reading and how many observations wait for their recording's camera. |
| unplaced | self, owner, collection | The observations that wait for their recording's camera: {observation id: recording id}. |
| set_projection | self, owner, collection, commits, cursor, scope, placed, unplaced | Record one reading of the commits: the cursor, which waiting observations found their place and which new ones wait. The newest UNPLACED_KEEP waiting observations are kept. |
| service | self | The service's note for this company: on once a sweep has read it, off when the host started the service switched off, waiting until either; and the fault of the last sweep. |
| note_service | self, state, fault | Write the service's note when it changes. |
| home_revision | state, owner, location_id | What a page polls: the revision of the owner's published page data, the trackers' output revisions, the location's schedule as the tools set it and the newest run. The revision moves once the new page data is in place. |
| location_name | company, location_id | The location's own name in the company's records. |
| projection_due | runs, state, owner, collection, drain | Whether a sweep has observations to bring into the location store for this owner and collection. |
| project_observations | company, runs, drain, limit | Bring the owner's committed observations of this collection into the location store. |
| at_daily_time | zone, daily_at, now | Whether the location's daily time has come on its own clock at now. A location with no daily time has its day from the first moment of it. |
| due | runs, state, owner, collection, location_id, now, pending_since | Why this location's trackers should run now: (trigger, stamp, day), else None. |
| pass_access | company, location_id | Confirm that the member a pass acts as manages the location and reaches every camera of it. |
| run_location | company, location_id, runs, trigger, stamp, day, budget_seconds, custom, clock | One pass of one location, under its lease. Returns the closed run, or None while another pass holds the lease. |
| script_phase | company, location_id, runs, claimed, result, custom, trigger, day, daily, published, clock | The script trackers of a pass, after its own work: its Core Trackers have run and its page data is published. |
| init | self, company, location_id, stamp | |
| mark | self | Call right before the run: the inputs present now are the ones this run reads. |
| done | self, result, page, covers_inputs | The run's result. covers_inputs says the run was the location's whole pass with its page. |
| host_pass | company, location_id, runs, wait_seconds, lease_seconds, beat_seconds, hold_seconds, clock, sleep | The lease a host command holds while it derives, runs or publishes a location. |
| renew | ||
| pass_company | state, access_state, environment, owner, collection | The handle an unattended pass acts through: the installing owner, with the membership the server itself reads. A member is a person of the access registry who is an owner or operator of this company; anyone else is no member, whatever one leftover row says. |
| member | principal | |
| environments | access_state | Every company environment in the access registry. |
| environment_state | root, environment | The state directory of one company environment. |
| note_fault | root, environment, runs, error | One company's stores stopped its sweep. The fault is logged once, where an operator reads it, and kept in that company's service note, where its tools read it. |
| note_swept | root, environment, runs | One company was read whole: its service note says on, and an earlier fault is over. |
| tracker_pass | root, access_state, clock, custom, limit, stop, pending_since, served | One sweep over every company environment: project, probe, and run what is due. |
| company | owner, collection, environment, state, opened | |
| runner_state | root, access_state, environ | The server's handle on this job, made once at startup. ROCOTO_TILE_RUNNER=off stops it, and each company with trackers then reads off in its service note, so a tool that takes a request says the request waits. |
| tracker_start | app_state, sandbox | Called once on the server's event loop as it starts: script trackers join the passes. |
| recover_script_jobs | root, access_state, box | Clear the sandbox jobs each company's ledger still lists as open. Returns how many were cleared. |
| tracker_tick | app_state | Called every second by the server loop: one sweep at a time, a new one every PROBE_SECONDS. |
| tracker_stop | app_state | At shutdown: ask the sweep to stop between locations and wait for the pass in hand to close its run row. |
harness/verticals/retail/tracker_scripts.py
| Function | Arguments | Source description |
|---|---|---|
| _listed | names | |
| init | self, errors | |
| canonical | value | The sandbox's own canonical JSON (custom_worker.canonical). |
| iso | epoch | |
| fault | code, message, **more | |
| named | name, period | |
| job_periods | company, location_id, data, day | The periods of one job: the day, then the week, the month and the year the page reads. |
| prior_of | output | What a script reads of the output published before its run. |
| without_internal | value | A host row as a script reads it: the host's own provenance fields left out at every depth. |
| build_input | data, tracker, periods, connections, prior, seconds | The JSON document one job reads: the periods, the tracker's own events and bounded location rows. |
| input_digest | document | The identity of a job's input: everything a script computes from. The prior output stays out, so a script that reads it still settles on one result for the same events and records. |
| input_parts | document | The input as the files a job mounts: [('input/000.json', bytes), …], each within one file's size. |
| snapshot_for | company_id, owner, collection, tracker_id, revision, source, parts, runtime | The sandbox bundle of one job: the entry, the script and the input, as the broker checks it. |
| _number | value | A number an output may carry: a finite float, or a whole number inside NUMBER_LIMIT. |
| _text | value, most, least | |
| host_field | name | Whether a page reads this name as a picture, a clip or a link. |
| _free | value, path, errors, depth | A value under a key of the script's own: numbers, words and lists and objects of them, up to six levels. An object here is the script's own data and never an evidence row: the fields a page reads as a picture, a clip or a link, and the fields of a row's identity, are refused at every depth. |
| _shown | key | A key of the script's own as an error path names it: its first 40 characters. |
| point_time | value | A point's time as the host stores it: UTC, ending in Z, the form the Core Trackers write. None for a text that is another form of time, or none. |
| _points | value, path, errors | |
| _rows | value, path, most, events, visits, errors | Evidence rows, rebuilt from the host's own records: the script chooses ids and words. |
| validate_output | value, tracker, document | One period's output, checked against the contract. Returns what publish_output stores. |
| _size | value | The bytes of a value's canonical JSON; past every size for a value JSON cannot hold. |
| slot_texts | slots, *written | Each marked slot with the text written for the same facts, where one was written. |
| publish_output | data, tracker, period, accepted, script_revision, texts | Write a validated output through the one writer of every tracker's output. |
| content_of | tile, canvas | The content hash common.publish gives a tile and canvas: their revision stays out of it. |
| evaluate | result, tracker, document | What a sandbox job amounts to: its status and, for a job whose every period is valid, the accepted outputs in period order. |
| validate_source | text | |
| init | self, path, clock | |
| init | self, **options | |
| run | self, tracker_id, **options | |
| switches | environ | The two host switches of script runs: the sandbox, and runs on the events trigger. |
| box | This process's sandbox handle. It stays switched off until configure has read the host's switches. |
|
| configure | loop, environ, sandbox, root | Called once as the service starts: the event loop script jobs run on, the host's switches and, with root, the service's state root, where the count of script jobs is kept. |
| script_id | tracker | |
| _suffix | tracker | |
| _saved | state, owner, kind, key | One record of the location store, read without opening the company for writing. |
| init | self, company, clock | |
| _get | self, kind, key | |
| head | self, tracker | |
| revision | self, tracker, revision | |
| output | self, tracker | |
| proposal | self, tracker | |
| _change | self, tracker, change | Apply change(head, put) to the head inside one transaction and return what it returns. |
| put | kind, value | |
| drop | kind, key | |
| get | kind, key | |
| save | self, tracker, source, expected_revision, policy, chat_id | Store the source as the next draft revision. expected_revision is the revision read, 0 for the first. |
| change | head, put | |
| set_policy | self, tracker, changes, expected_revision | |
| change | head, put | |
| admit_job | self, tracker, most | Count one sandbox job against the tracker's day. False once the day's number is reached. |
| change | head, put | |
| refund_job | self, tracker | Give the day its count back for a job the sandbox never took. |
| change | head, put | |
| record_test | self, tracker, revision, status, run_id | Keep the last test of the head revision. A passing test of the paused revision starts the script again. |
| change | head, put | |
| publish | self, tracker, expected_revision | Make the head revision the one that runs. It needs the passing test of that very revision. |
| change | head, put | |
| after_run | self, tracker, revision, detail, error, input_sha256 | Carry a run into the script's health: its last run, its last good run, and the pause after PAUSE_AFTER stopped runs in a row. error is the run's own fault with the script's words; the health keeps it for the readers get_tracker_script shows it to. |
| change | head, put | |
| note_day | self, tracker, day, done, retry | Keep how the script stands for a local day of its location: whether its run for that day is done, and how many passes the tracker service has asked for by itself. |
| change | head, put | |
| propose | self, tracker, proposal | |
| change | head, put | |
| drop_proposal | self, tracker, proposal_id | |
| change | head, put | |
| put_readings | self, tracker, output, readings, script_revision | Store the week, month and year readings of the published output. They follow the output that stands now: a text written meanwhile gave it a newer revision. |
| change | head, put | |
| clean_policy | value | A script's two policies, checked: when a valid output is published and when the agent is woken. |
| saved_readings | company, location_id, trackers | The week, month and year readings of each script tracker's published output: {key: {name: {tile, canvas}}}. |
| pause_reason | paused, words | Why a script is paused. With words the sentence carries the script's own message; a reader outside the location's cameras gets the code and the line. |
| _plain_stop | error | A stopped run in this host's own words: its code and its line. |
| health_of | head, words | A script's health as the tools return it. |
| describe | head, words | What get_tracker returns of a tracker's script: its revision, policy, health and last test. |
| describe_saved | state, owner, tracker | describe for a reader without a company handle: the head is read from the store's file. |
| _bundle | periods, accepted | |
| readings_of | data, tracker, bundle, script_revision | The week, month and year readings of a job, as the page reads them. Nothing is stored. |
| writing | tracker | The lock of one tracker's output in this service. A run's publish reads the output that stands and writes its next revision, and so does a written text: each holds this lock for the whole of that, so one never writes over the other. |
| publish_bundle | scripts, data, tracker, bundle, script_revision, written | Publish a job's day output and store its week, month and year readings beside it. |
| preview_bundle | scripts, data, tracker, bundle, script_revision, written | The tile and canvas a bundle would publish for its day, their content hash, and the hash of the same content before any text is written: (shown, content, unwritten). Nothing is stored. |
| _sentence | error | A run row's words for a script that stopped: this host's own. The script's message stays with the script's health, where get_tracker_script reads it with the location's cameras. |
| _public_error | error | A run's fault as a run row keeps it: the code, the line, the period and this host's sentence for the code. |
| show_on_page | company, tracker | Carry one tracker's stored output and readings into the owner's published page, without a pass: the page publisher assembles that one row again. Returns whether the page data changed. |
| wake_agent | company, tracker, event_id, text, clock, camera_ids | Enqueue one wake for the tracker's Tracking Agent through the durable wake queue, inside its bounds. |
| current_producer_authority | definition, actor | |
| wake_text | tracker, detail, head, error, output, proposal | One short factual message for the agent a run wakes. The agent is the tracker's own: the message carries the script's words for a run that stopped. |
| run_script_tracker | company, location_id, tracker, period, data, sandbox, clock, signals | One script tracker inside a pass. Synchronous: the pass calls it in its thread. |
| closed | status, **more | |
| later | message, retry | A run that waits: its day stays owed, and with retry the service asks for the next pass. |
| perform | control | |
| opened | job | |
| job_closed | job | |
| sandbox_processor | sandbox | The custom callback of run_trackers: a company's script tracker, run in the sandbox. |
| custom | tracker, company, location_id, period, data | |
| test_script | company, tracker, expected_revision, cancelled, sandbox, clock | Run the head revision in the sandbox over the location's present data. Nothing is published. |
| prepare | ||
| conclude | ||
| publish_script | company, tracker, expected_revision | Make the head revision the one that runs: the script's record, then the tracker's processor layer. |
| approve_output | company, tracker, proposal_id | Publish the proposal a review-mode script is waiting with. Returns the stored output. |
| write_text | company, tracker, slot, text, output_revision, proposal_id, clock | Store a written text in one slot of the published output, or of the waiting proposal. |
| named | entries | |
| change | head, put | |
| _tool | name, description, properties, required | |
| specs | write | |
| _record | context, tracker_id | The saved tracker record a tool names: by its own id, or by the id of its Tracking Agent. |
| _script_runs | context, record, limit | The tracker's newest script runs, each as one entry of the location's run history. |
| _unlinked | context, tracker_id | A Tracking Agent of the reader that has yet to get its tracker record, by the id list_trackers gives it. |
| script_camera_ids | state, owner, record | The cameras whose data a script's current output, proposal or run message may contain. |
| reads_cameras | context, record, *records_ | Whether the reader's present access covers every camera a script's words come from: the cameras of the location, and the ones a stored output or proposal names. A script copies what it reads into its summary, its facts and the message of its own exception, so each of those is read with the cameras, like a Core Tracker's output. |
| read | context, name, args | |
| _installed | context | The locations whose Core Trackers the writer installed: where that member's trackers run. |
| _writable | context, company, args, link | The company's own tracker a write names, with the writer's authority over it checked. |
| link_check | context, company, location_id, installed | Whether the writer may give a Tracking Agent its tracker record at a location: a location in their access that they manage and whose Core Trackers they installed, with room for one more. Raises with the sentence that says what is needed. |
| link_agent | context, company, location_id, agent, installed | The tracker record of a Tracking Agent, written at a location through add_tracker the first time. |
| promote_link | context, company, agent, location_id | After a chat became a Tracking Agent: its tracker record, where a location is named or the writer has one installed location. Returns {'tracker': record or None, 'next_step': sentence or None}. |
| _public_head | head | |
| _page | company, record | What a tool says of the page after it changed an output: the tracker's own row is assembled again from the stored output, with no pass and no script run. |
| call | context, name, args | The family's writes, in the hosted parent conversation. A Core Tracker answers each with LOCKED. |
| acall | context, name, args | The family's awaited write: a test runs its sandbox job on the event loop of the turn. |
harness/verticals/retail/visit_basket.py
| Function | Arguments | Source description |
|---|---|---|
| counted | self | |
| evidence_key | owner, event_id | |
| item_key | owner, collection, recording, reference | |
| project | events, receipts, products, visit_id, at_s, valuation_at | Pure reducer over already-authorized inputs; quantities are absolute counts. |
| describe | item | |
| init | self, locations, verifier | |
| _visit | self, owner, visit_id | |
| admit | self, owner, definition | Host-only receipt admission; verifier is executable host policy, not input. |
| admit_model | self, owner, event_id, pipeline | Produce an immutable qualified estimate from an admitted raw response. |
| at | self, owner, visit_id, at_s, valuation_at |
harness/verticals/retail/watch_screening.py
| Function | Arguments | Source description |
|---|---|---|
| nonempty | self | |
| bounds | self | |
| digest | value | |
| source_key | clip | |
| encoder_identity | index | |
| author_plan | state, plan, revision, owner, context | |
| validate_plan | record, state | |
| coalesce | records | |
| init | self, state, index | |
| screen | self, record, sources, snapshot |
harness/verticals/retail/web/camera-streams.js
| Function | Arguments | Source description |
|---|---|---|
| render | { connections = [], query = '', loading = false, error = '', canManage = false, onSetup, onRetry }, { node, icon } |
harness/verticals/retail/web/control-room.js
| Function | Arguments | Source description |
|---|---|---|
| create | options = {} | |
| read | path | |
| profileName | agent | |
| agentById | id | |
| agentFrequency | agent | |
| savePick | id, family | |
| carryFormerPick | id | |
| home | ||
| buildHome | ||
| incidentCard | incident, index | |
| legacyDetail | agent | |
| syncPhone | focused | |
| applyPeriod | period, source | |
| closeDetail | ||
| mountCanvas | agent | |
| mountLegacy | agent | |
| watch | ||
| render | ||
| openTracker | id | |
| openCore | tracker | |
| openFrom | detail | |
| fromFrame | event | |
| loadObservations | id | |
| load | ||
| goHome | ||
| handle | event |
harness/verticals/retail/web/control-room/app.js
harness/verticals/retail/web/control-room/control-room.js
| Function | Arguments | Source description |
|---|---|---|
| refreshData | ||
| loadNext | ||
| placeWeather | home | |
| showOverview | ||
| showCameras | ||
| closeSession | ||
| openSession | target | |
| nameBack | name | |
| applySnapshot | snapshot | |
| askRevision | ||
| trackerState | schedule, run | |
| showTrackers | next | |
| refreshPage | ||
| checkRevision | ||
| init |
harness/verticals/retail/web/control-room/home-history.js
| Function | Arguments | Source description |
|---|---|---|
| kindOf | tile | |
| span | seconds | |
| parts | value, unit | |
| seriesText | tile, value | |
| moment | at, model, withDay | |
| day | at, model | |
| waitsOf | tile | |
| distributionOf | tile | |
| shelvesOf | tile | |
| moneyText | amount, currency, model | |
| canvasShelf | shelf | |
| resolve | tile | |
| connectCopy | tile, model | |
| send | type, detail, cancelable=false | |
| openSession | entry | |
| openAgent | ||
| thumb | entry, list, index, model | |
| row | entry, list, index, model, middle, lead, attributes='' | |
| eventRows | events, tile, model | |
| shelfRows | shelves, model | |
| groupRows | groups, tile, model | |
| figures | tile | |
| periodToggle | tile, model | |
| compose | tile, model | |
| stopPreviews | ||
| preview | rowNode, on | |
| render | change | |
| choosePeriod | period, focus | |
| build | surface | |
| morph | dialog, element, opening | |
| open | tile, model, element, opts | |
| finish | restore | |
| close | ||
| update | tile |
harness/verticals/retail/web/control-room/home-marks.js
| Function | Arguments | Source description |
|---|---|---|
| monotone | points | |
| clear | el, kind, opts | |
| line | el, points, opts={} | |
| ring | el, fraction, opts={} | |
| bars | el, values, opts={} |
harness/verticals/retail/web/control-room/home-model.js
| Function | Arguments | Source description |
|---|---|---|
| isoTime | value | |
| eventRow | e, index | |
| visitorRow | v, index | |
| format | kind, value, currency | |
| seriesRows | rows | |
| bucketed | events, period, now, measure | |
| queueWait | events | |
| suppliedTile | row, period, index, currency | |
| from | input, options |
harness/verticals/retail/web/control-room/journey-model.js
| Function | Arguments | Source description |
|---|---|---|
| configure | profile | |
| clean | value | |
| canonicalActionTitle | event | |
| eventDescription | event | |
| personKey | recordingId, personId | |
| stableEventId | recordingId, windowIndex, eventIndex, event | |
| eventAnchorFromTracks | tr, personId, time_s | |
| activityAt | events, personId, time_s | |
| isProductInteraction | event | |
| majorInteractionAt | events, personId, time_s |
harness/verticals/retail/web/control-room/location-data.js
| Function | Arguments | Source description |
|---|---|---|
| isFixtureTarget | event | |
| displayDescription | value | |
| captureDate | clip | |
| imageOf | e | |
| metricSource | value, needed | |
| build | {clips=[], tracks={}, locationMetrics=null, model='8b', eventTypes=null, page=null}={} | |
| session | personId |
harness/verticals/retail/web/control-room/location-view.js
| Function | Arguments | Source description |
|---|---|---|
| create | options | |
| listen | element, type, handler, opts | |
| renderPlace | ||
| renderFootage | ||
| release | ||
| play | ||
| rest | ||
| nextRecording | ||
| traceOf | recording | |
| clearTags | ||
| drawTags | ||
| tagLoop | ||
| drawMark | node, tile | |
| tileNode | tile | |
| paintTile | node, tile, fresh | |
| fitUnit | node, tile | |
| tick | node | |
| renderTiles | ||
| stampOf | tile | |
| newTracker | ||
| open | key, node | |
| openTile | tile | |
| renderProducts | ||
| stopPreviews | ||
| clearPreviews | ||
| bindPreview | row, video, event, start, end | |
| openProduct | product | |
| renderNeighbourhood | ||
| catalogLocationParams | ||
| catalogMethodButton | method | |
| openCatalogSetup | ||
| requestCatalogMethod | method, setup | |
| renderCatalogImport | ||
| createPhotoHandoff | ||
| loadAgents | ||
| render |
harness/verticals/retail/web/control-room/maintained-player.js
| Function | Arguments | Source description |
|---|---|---|
| windowRange | value | |
| mapping | clip | |
| streamTime | clip, localTime | |
| localTime | clip, time | |
| safeUrl | value, base=root.location?.href | |
| point | value | |
| place | value | |
| bootstrap | value, base=root.location?.href | |
| session | clips, clip | |
| following | clips, clip | |
| validate | value, requested | |
| create | {fetcher=(...args | |
| refill | ||
| notify | ||
| cancel | ||
| clear | nextStatus='idle' | |
| schedule | delay | |
| pump | ||
| update | next | |
| suspend | flag | |
| invalidate | ||
| destroy | ||
| visitors | value | |
| visit | value, visitId | |
| trackerVisit | value, clip, track, at | |
| chapters | value, visitId, clips |
harness/verticals/retail/web/control-room/motion-timeline.js
| Function | Arguments | Source description |
|---|---|---|
| profile | track, personId | |
| paths | groups, duration, width=1000, height=42 | |
| at | groups, time |
harness/verticals/retail/web/control-room/person-outline-worker.js
| Function | Arguments | Source description |
|---|---|---|
| edgeTexture | values, size, rect |
harness/verticals/retail/web/control-room/person-outline.js
| Function | Arguments | Source description |
|---|---|---|
| finite | value, fallback | |
| normalizeBox | value | |
| area | box | |
| intersection | a, b | |
| create | options | |
| clear | ||
| notify | ||
| fail | ||
| ensureCanvas | width, height | |
| buildEdgeTexture | message | |
| drawMask | mask, box, width, height | |
| significantOverlap | box, others | |
| acceptMask | message | |
| onWorkerMessage | event | |
| startWorker | ||
| flushQueued | ||
| submit | box, sourceWidth, sourceHeight, personId, time | |
| update | frame | |
| status | ||
| stopEngine | nextState | |
| startEngine | ||
| setSuspended | value | |
| setEnabled | value | |
| onVisibility | ||
| destroy |
harness/verticals/retail/web/control-room/player-lifecycle.js
| Function | Arguments | Source description |
|---|---|---|
| create | options | |
| hide | ||
| show | ||
| visibility | ||
| play |
harness/verticals/retail/web/control-room/room-loop.js
| Function | Arguments | Source description |
|---|---|---|
| create | recordings, now=( | |
| positionAt | elapsed_s |
harness/verticals/retail/web/control-room/visit-basket.js
| Function | Arguments | Source description |
|---|---|---|
| create | {host, fetcher=(...args | |
| clear | ||
| image | url | |
| row | item, uncertain=false | |
| render | value | |
| showSnapshot | next | |
| within | value, time | |
| update | next | |
| invalidate | ||
| destroy |
harness/verticals/retail/web/control-room/weather-widget.js
| Function | Arguments | Source description |
|---|---|---|
| cityOf | address, zone | |
| monotone | points | |
| layout | values, {width, height, top, bottom, left, right} | |
| lineMark | values, box, {dots=false}={} | |
| ghostMark | box, stretch | |
| create | {host, onLocation, place:configured, enabled=true}={} | |
| drawChip | ||
| daily | today | |
| figure | now, full | |
| drawPreview | ||
| hidePreview | ||
| showPreview | ||
| hoursHtml | ||
| daysHtml | ||
| drawSheet | force | |
| buildSheet | ||
| open | ||
| close | ||
| draw | ||
| refresh | visible | |
| mountMap | ||
| map | el, opts={} |
harness/verticals/retail/web/retail-scope.js
| Function | Arguments | Source description |
|---|---|---|
| render | { data = null, loading = false, error = '', onSave, onRetry } = {}, { node = make } = {} | |
| draw | ||
| edit | kind, original, opener | |
| input | name, label, initial, required = false | |
| select | name, label, rows, initial | |
| checks | name, label, rows, selected, emptyText | |
| refresh | nextRows | |
| renderSelector | { data = null, locations = [], loading = false, error = '', busy = false, readOnly = false, onSave, onOpen, onRetry } = {}, { node = make } = {} | |
| isAll | ||
| label | ||
| drawChoices | ||
| position | ||
| stopWatching |
harness/verticals/retail/web/retail-shell.js
| Function | Arguments | Source description |
|---|---|---|
| mountLocation | slot, config |
harness/verticals/retail/web/retail-ui.js
harness/verticals/retail/web/tracker-canvas.js
| Function | Arguments | Source description |
|---|---|---|
| stateOf | type | |
| shelves | events, now | |
| ranking | events | |
| outputShelves | list, events, now | |
| outputRanking | items, events | |
| stateCanvas | view, ui, context | |
| rankingCanvas | view, ui, context |
harness/web/app.js
harness/web/business-map.js
| Function | Arguments | Source description |
|---|---|---|
| safeURL | value | |
| validate | data | |
| geometry | value, allowed | |
| collection | value, allowed | |
| loadD3 | ||
| glyph | category | |
| dispose | root | |
| render | input, { node = make, icon, onExpand } = {} | |
| select | key, label, values | |
| renderSelection | ||
| positionPins | ||
| labels | ||
| scaleBar | ||
| updateLayers | ||
| resize |
harness/web/business-summary.js
| Function | Arguments | Source description |
|---|---|---|
| render | data, { node, icon, safeUrl, sourceIcon } | |
| reference | value | |
| link | href, label, symbol, className = 'business-summary-action' | |
| renderProfile | data, helpers | |
| addList | title, values, className |
harness/web/display-canvas.js
| Function | Arguments | Source description |
|---|---|---|
| create | extend = ( | |
| el | tag, props, ...kids | |
| svg | tag, props, ...kids | |
| safeUrl | value | |
| ownUrl | value | |
| stamp | value | |
| dayName | ms, now | |
| when | ms, now | |
| span | ms | |
| cadence | agent | |
| inline | text, inert | |
| rich | text, className = 'tc-rich', inert = false | |
| sections | text | |
| occurrence | raw, index, published | |
| family | agent, observations | |
| signals | events | |
| buckets | period, now | |
| metric | events, period, now | |
| memosOf | data, summary | |
| format | kind, value, currency | |
| written | row, other | |
| reading | out, period | |
| bound | canvas, name, text | |
| shownOutput | out, saved, kind, set, period | |
| outputMetric | series, events, period | |
| model | agent, observations, options = {} | |
| curve | points | |
| layout | values, box | |
| lineMark | values, box, className | |
| kitMark | kind, points, opts | |
| lineChart | { title, points, selected, onSelect, read } | |
| show | next | |
| spark | values | |
| stopPreview | ||
| startPreview | frame, item | |
| thumb | item, host | |
| occurrenceRow | item, context, options = {} | |
| occurrenceList | items, context | |
| rail | title, count, body, extra | |
| facts | view | |
| periodToggle | current, onChange | |
| recommendation | text, inert = false | |
| metricCanvas | view, ui, context | |
| occurrenceCanvas | view, ui, context | |
| feedEntry | item, context, fresh | |
| feedList | items, context, fresh | |
| liveRail | view, ui, context | |
| liveCanvas | view, ui, context | |
| blockCanvas | view, ui, context | |
| restingCanvas | ||
| mount | options = {} | |
| openPicker | ||
| closePicker | keepFocus | |
| pick | id | |
| picker | ||
| head | ||
| place | name, node | |
| watchEarlier | ||
| paint | force, focusKey | |
| tile | options = {} | |
| displayInput | display | |
| mountDisplay | options = {} | |
| tileDisplay | options = {} |
harness/web/display-charts.js
| Function | Arguments | Source description |
|---|---|---|
| valueOf | point | |
| monotonePath | points | |
| lineLayout | samples, box | |
| polar | cx, cy, r, degrees | |
| arcPath | cx, cy, r, from, to | |
| barPath | x, top, width, base, radius | |
| bezier | x1, y1, x2, y2 | |
| parseEasing | text, fallback | |
| parseDuration | text, fallback | |
| tween | ms, ease, step, done | |
| surfaceOf | host, asked | |
| mount | host, kind, fallback | |
| pointLabel | point | |
| line | host, points, opts | |
| place | values | |
| drawIn | ms | |
| settle | ||
| render | reason | |
| valueText | index | |
| showFocus | index, announce=true | |
| hideFocus | announce=true | |
| nearest | clientX | |
| step | delta | |
| gauge | host, fraction, opts, kind | |
| box | ||
| place | f | |
| render | reason | |
| bars | host, values, opts | |
| litIndex | ||
| place | heights | |
| render | reason | |
| ghost | host, kind, opts | |
| render |
harness/web/harness-shell.js
| Function | Arguments | Source description |
|---|---|---|
| parse | data |
harness/web/messaging-settings.js
| Function | Arguments | Source description |
|---|---|---|
| channelList | data | |
| contactsFor | member, data | |
| deliveryLabel | delivery | |
| deliveryText | delivery | |
| chipLabel | delivery | |
| senderLabel | sender, ownId | |
| api | path, body | |
| button | node, label, fn, className = 'messaging-button' | |
| avatar | node, member, large = false | |
| labelValue | node, label, value | |
| render | data = {}, { node = make, icon, onMember, onSetup } = {} | |
| openMember | { member, data = {}, page = 'profile', channel: wanted = '', purpose = '', onClose, onRequestCode, onVerifyCode, onSetup, node = make, icon } = {} | |
| selected | ||
| dispose | ||
| close | ||
| setup | ||
| show | next | |
| focus | key | |
| input | label, value, key, { placeholder = '', autocomplete = '', maxLength = 30 } = {} | |
| run | action, apply | |
| channelPicker | active | |
| draw | preferred | |
| valid | ||
| sync | ||
| openContactCard | { block, participant, agentTitle = '', node = make, icon, onClose } = {} | |
| mountPhone | { agentId, agentTitle = '', node = make, icon, readOnly = false, onChange } = {} | |
| schedule | ||
| load | quiet = false | |
| change | path, body, focusKey | |
| contactCard | participant | |
| addNumber | participant, key | |
| toggle | label, checked, key, disabled, apply | |
| spendLine | spend | |
| hold | value | |
| participantRow | person, manage | |
| draw | preferred | |
| restore | key |
harness/web/plugin-settings.js
| Function | Arguments | Source description |
|---|---|---|
| render | data = {}, { node = nodeDefault, icon, logo, onOpen, onBrowse, onAdd } = {} | |
| action | label, callback, primary = false | |
| show | kind, focus = false |
harness/web/profile-settings.js
| Function | Arguments | Source description |
|---|---|---|
| render | data, { node = defaultNode, icon, scope = 'person', mode = 'daily', loading = false, error = '', onMode, onAgent } = {} | |
| chart | target, metric, label | |
| update | value |
harness/web/question-box.js
| Function | Arguments | Source description |
|---|---|---|
| element | tag, className = '', text = '' | |
| mount | container, request, helpers = {} | |
| update | ||
| render | ||
| proceed | ||
| send | action | |
| tick |
harness/web/rich-content.js
| Function | Arguments | Source description |
|---|---|---|
| configure | marked | |
| script | path, global | |
| mathAssets | ||
| language | code | |
| button | node, icon, label, symbol, action | |
| copyButton | node, icon, label, text | |
| toolbar | node, label | |
| actions | node, label | |
| displayLanguage | lang | |
| expand | node, icon, title, build, opener | |
| tableText | table | |
| allowedDiagram | source | |
| diagram | source, target, node | |
| enrich | root, { node = defaultNode, icon = null, pending = false } = {} |
harness/web/settings-shell.js
| Function | Arguments | Source description |
|---|---|---|
| mount | { node, icon } | |
| filter |
harness/web/tool-trail.js
| Function | Arguments | Source description |
|---|---|---|
| normalizeFramePreviews | value | |
| argumentsOf | tool | |
| references | tool, args | |
| safeThumbnail | value, doc | |
| measure | viewport | |
| refresh | root | |
| render | tools, { pending = false, renderTool, icon, resolveReference, resolveMedia } = {} | |
| individual | tool, index | |
| group | items |
harness/web/wake-controls.js
| Function | Arguments | Source description |
|---|---|---|
| create | {node, icon, scope} | |
| close | restore=true | |
| current | state | |
| sync | ||
| open | opener |
harness/web/workspace-extensions.js
| Function | Arguments | Source description |
|---|---|---|
| register | id, factory | |
| install | context |
harness/web/workspace-home.js
| Function | Arguments | Source description |
|---|---|---|
| mount | root, context |
harness/web/workspace-settings.js
| Function | Arguments | Source description |
|---|---|---|
| normalize | value = {} | |
| key | identity | |
| read | identity | |
| write | identity, preferences | |
| apply | preferences = defaults | |
| permission | ||
| requestPermission | ||
| notify | preferences, title, onOpen | |
| render | view, data = {}, { node, icon, onChange, onPermission, onUsage, onMember } = {} |
harness/web/workspace-tabs.js
| Function | Arguments | Source description |
|---|---|---|
| register | id, tabs | |
| create | {root, context, defaultHome, onError=( | |
| configure | shell, workspaceIdentity | |
| open | id='home' | |
| setVisible | value |
tools/authorize_local_budget.py
| Function | Arguments | Source description |
|---|---|---|
| authorize | state, amount_usd, days, acknowledged | |
| main |
tools/check-processed-sample.py
| Function | Arguments | Source description |
|---|---|---|
| main | ||
| get | path, headers |
tools/configure.py
| Function | Arguments | Source description |
|---|---|---|
| private_path | path | |
| read_env | path | |
| write_env | path, values | |
| main |
tools/dev.py
| Function | Arguments | Source description |
|---|---|---|
| main | ||
| record_attempt | ||
| local | address | |
| connect | s, address | |
| connect_ex | s, address | |
| dns | host, *a, **kw |
tools/distribution.py
| Function | Arguments | Source description |
|---|---|---|
| files | ||
| main |
tools/offline/sitecustomize.py
| Function | Arguments | Source description |
|---|---|---|
| local | address | |
| check_connect | self, address | |
| check_connect_ex | self, address | |
| check_dns | host, *a, **kw | |
| init | self, args, *a, **kw |
tools/preview_app.py
| Function | Arguments | Source description |
|---|---|---|
| init | self, app, secure | |
| admitted | self | |
| call | self, scope, receive, send | |
| observed | message | |
| public_sample | app, prefix, secure, public_origin |
tools/processed_sample.py
| Function | Arguments | Source description |
|---|---|---|
| digest | path | |
| verify_sample | directory | |
| download_sample | ||
| install_sample | state, sample | |
| rebind | value |
tools/render-fixture.py
| Function | Arguments | Source description |
|---|---|---|
| box | t | |
| frame | t |
tools/seed.py
| Function | Arguments | Source description |
|---|---|---|
| private_state | path | |
| write_json | path, data | |
| seed | path, issue_code | |
| main |
tools/serve.py
| Function | Arguments | Source description |
|---|---|---|
| main |
tools/source-map.py
| Function | Arguments | Source description |
|---|---|---|
| main |
tools/verify.py
| Function | Arguments | Source description |
|---|---|---|
| main |