AI & ML

Aiml

Explore the data types and operations available in Aiml.

88 operations

listMagicQueriesQuery

Lists every available Magic Query noun with a short description and its options — the discovery entry point.

listMLModelConfigsQuery

List ML model configs with pagination and filtering. Requires mlmodelconfig:list permission.

listMLModelConfigVersionsQuery

List versions for an ML model config, newest first, with pagination. Requires mlmodelconfig:read permission.

magicQueryQuery

Executes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.

markKnowledgeNotesContradictMutation

Record that two notes contradict each other; the conflict is surfaced by `retrieveKnowledge` via `KnowledgeHit.contradicts`. Requires knowledgeNote:write permission.

mlExperimentQuery

Open one of your ML experiments, which marks it active; null when you have no such experiment. Requires mlmodelconfig:execute permission and a signed-in user.

mlExperimentRunStatusSubscription

Stream one of your experiment runs: its current state, then its result when it finishes. Requires mlmodelconfig:execute permission and a signed-in user.

mlModelTrainingStatusSubscription

Stream real-time training status events for an ML model config.

myMLExperimentsQuery

Your ML experiments, most recently active first, ordered as stored when each page is read: an experiment opened while you page moves to the front and may be skipped or repeated. Requires mlmodelconfig:execute permission and a signed-in user.

pingQuery

Health check endpoint

pinMLExperimentRunMutation

Pin or unpin one of your experiment runs. A pinned run never expires. Pinning is refused once the experiment has the workspace's maxPinnedRuns pinned runs ("Unpin a run first"), or when that setting is 0 ("Pinning is turned off in Settings"); unpinning never is. Requires mlmodelconfig:execute permission and a signed-in user.

predictMLExperimentRunMutation

Try one of your experiment runs: predict with its model. Expired and forecast runs are refused. Requires mlmodelconfig:execute permission and a signed-in user.

predictMLModelMutation

Run a prediction using a trained ML model. Requires mlmodelconfig:execute permission.

previewMLExperimentPipelineMutation

Run an experiment's data pipeline over a sample of its CSV WITHOUT training and return the emitted fields. Requires mlmodelconfig:execute permission and a signed-in user.

previewMLModelPipelineMutation

Run the data pipeline over a sample WITHOUT training and return the emitted fields. Requires mlmodelconfig:execute permission.

publishMLModelVersionMutation

Set a version as the published version used for predictions. Requires mlmodelconfig:write permission.

renderSchemaXMLQuery

Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.

reportQueryQuery

Execute a MicroSQL reporting query against the analytics schema. Supports SELECT with WHERE, JOIN, ORDER BY, GROUP BY, LIMIT. Tenant isolation is enforced automatically. Covers production (jobs, components, operations, milestones), prepress, scheduling (work_centers, planned_operations, schedule_allocations), sales (estimates, orders, invoices), cost accounting, catalog/inventory (products, substrates, warehouse_stock), logistics (shipments), tasks, time-series (metric_points, progress_points), and people (users, teams). Per-table IAM authorization is enforced — requires :list on each table's resource.

retrainSystemModelsMutation

Manually trigger retraining of all system-managed ML models for the current tenant. Requires mlmodelconfig:execute permission.

retrieveKnowledgeQuery

The retrieval (RAG) entry point. Given the entities in context (`seeds`) and an optional `query`, returns the most relevant knowledge in two buckets — graph-reached and semantically-supporting — each ranked by a blended relevance score. Requires knowledgeNote:read permission.

schemaAuthoringCatalogQuery

Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.

searchHelpQuery

Search human-facing manuals using shared semantic and text retrieval.

sendChatMessageMutation

Send a message to a chat session and receive an AI response. Requires chatsession:write permission.

testAIAdapterMutation

Verify provider credentials and all effective configured models using provider model endpoints. Does not generate content. Requires aiadapter:read permission.

trainMLExperimentMutation

Train an experiment's current XML on its CSV as a new numbered run. One run trains at a time per experiment, and at most two per workspace. Older unpinned runs beyond the workspace's keepUnpinnedRuns setting expire. Requires mlmodelconfig:execute permission and a signed-in user.

trainMLModelMutation

Trigger training for an ML model. Requires mlmodelconfig:execute permission.

unmarkKnowledgeNotesContradictMutation

Remove a previously recorded contradiction between two notes. Requires knowledgeNote:write permission.

updateAIAdapterMutation

Update an AI adapter. Only provided fields are changed. Requires aiadapter:write permission.

updateAIAgentMutation

Update an AI agent. Only provided fields are changed. Requires aiAgent:write permission.

updateChatSessionMutation

Update an existing chat session. Requires chatsession:write permission.

updateConceptMutation

Rename or reclassify an existing concept. Requires concept:write permission.

updateKnowledgeNoteMutation

Edit a note's body or scope, or supersede it with a replacement. The attachment is immutable. Requires knowledgeNote:write permission.

updateMLExperimentMutation

Rename one of your ML experiments or change its draft XML. Requires mlmodelconfig:execute permission and a signed-in user.

updateMLModelConfigMutation

Update an ML model config. Only provided fields are changed. Requires mlmodelconfig:write permission.

upsertAIAdapterMutation

Create or update an AI adapter. Requires aiadapter:write permission.

upsertAIAgentMutation

Create or update an AI agent. Requires aiAgent:write permission.

upsertMLModelConfigMutation

Create or update an ML model config. Requires mlmodelconfig:write permission.

upsertMLModelSourceMutation

Create or replace ML XML authoring source. Updates require the observed authoring revision and preserve training and publication state.