AI & ML

Aiml

Explore the data types and operations available in Aiml.

88 operations

analyzeMLModelSourceQuery

Check ml-model XML without saving it: returns { valid, diagnostics: [{ path, message, severity, sourceRange }], elements }, where elements is the compiler's vocabulary for editor completion. Requires mlmodelconfig:read permission.

captureKnowledgeMutation

Capture a knowledge subgraph — concepts, a note, and instance/semantic edges — in one atomic transaction. The manual, deterministic core of knowledge capture; the Phase-2 LLM path produces this same input. `scope` is caller-controlled. Requires knowledgeNote:write permission.

chatAIAvailabilityQuery

Report configured adapter eligibility for this tenant. This is not a live provider health check; use testAIAdapter to verify credentials and model access. ops needs only a login; the adapter ids require chatsession:read permission and are null without it.

chatMessageStreamSubscription

Stream AI responses for a chat message in real-time. Emits chunks as they arrive. Your own OPS sessions need only a login (one turn at a time); any other session requires chatsession:write permission.

clearChatMessagesMutation

Clear all messages from a chat session. Requires chatsession:write permission.

compileSchemaXMLQuery

Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.

conceptQuery

Fetch a single concept by ID. Requires concept:read permission.

conceptsQuery

List the tenant's concepts with pagination. Requires concept:list permission.

confirmKnowledgeNoteMutation

Endorse a note: increments its confirmation count (raising its retrieval trust weight) and promotes a PENDING note to LIVE. Requires knowledgeNote:write permission.

createAIAdapterMutation

Create a new AI adapter. Requires aiadapter:write permission.

createAIAgentMutation

Create a new AI agent. Requires aiAgent:write permission.

createChatSessionMutation

Create a new chat session. An OPS session needs only a login; any other context requires chatsession:write permission.

createConceptMutation

Manually author a concept in the ontology. Requires concept:write permission.

createKnowledgeNoteMutation

Contribute a knowledge note about a concept or an entity. Requires knowledgeNote:write permission.

createMLExperimentMutation

Start a personal ML experiment, blank or from an existing model's XML. Requires mlmodelconfig:execute permission and a signed-in user.

createMLModelConfigMutation

Create a new ML model config. Requires mlmodelconfig:write permission.

dataChangeEventsSubscription

Subscribe to real-time data change events. Requires read permission on each requested resource. Task topics are the exception: a signed-in user without task:read receives the events of their own tasks only (assigned to them, claimed by them, unclaimed on their teams).

deleteAIAdapterMutation

Delete an AI adapter. Requires aiadapter:delete permission.

deleteAIAgentMutation

Delete an AI agent. Requires aiAgent:delete permission.

deleteChatSessionMutation

Delete a chat session. Requires chatsession:delete permission.

deleteConceptMutation

Delete a concept. Requires concept:delete permission.

deleteKnowledgeNoteMutation

Delete a note and any graph edges it sourced. Requires knowledgeNote:delete permission.

deleteMLExperimentMutation

Delete one of your ML experiments with its runs and their models. Requires mlmodelconfig:execute permission and a signed-in user.

deleteMLModelConfigMutation

Delete an ML model config. Requires mlmodelconfig:delete permission.

describeQuerySchemaQuery

Analyze a MicroSQL query and return the inferred result schema (column names, data types) without executing it. Returns validation errors with typo-correcting suggestions if the query is invalid. Validates only against tables the caller can list.

exportMLModelConfigQuery

Export an ML model config as JSON or YAML. Requires mlmodelconfig:read permission.

forecastMLExperimentRunMutation

Try one of your forecast experiment runs: forecast the series it trained on. Expired runs and runs that are not forecasts are refused. Requires mlmodelconfig:execute permission and a signed-in user.

forecastMLModelMutation

Forecast future values using a trained time-series model. Requires mlmodelconfig:execute permission.

generateDefaultDataQueryQuery

Generate a default GraphQL data query for an event topic. Returns a query string with all scalar fields for the resource, or null if the topic has no matching query. The query uses $id as the variable for the resource ID.

getAIAdapterQuery

Fetch an AI adapter by ID. Requires aiadapter:read permission.

getAIAgentQuery

Fetch an AI agent by ID. Requires aiAgent:read permission.

getChatSessionQuery

Fetch one of your chat sessions by ID. Your own OPS sessions need only a login; any other session requires chatsession:read permission.

getMagicQueryGraphQLQuery

Resolves a Magic Query string to the real GraphQL operation and variables it runs, so consumers can graduate from the façade to raw GraphQL. Does not execute.

getMagicQuerySchemaQuery

Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.

getMLModelConfigQuery

Fetch an ML model config by ID. Requires mlmodelconfig:read permission.

getMLModelConfigVersionQuery

Get a specific ML model config version by ID. Requires mlmodelconfig:read permission.

helpChapterQuery

Read a chapter of the current published manual edition.

helpChaptersQuery

List human-facing manual chapters from the running deployment.

iacGuidesQuery

Every authoring guide, for a tool that syncs them to a folder. Intended for `schema pull` to call once and write to disk, not for an agent to call while authoring — a file can be grepped and re-read in part, where a response arrives whole.

iacSchemaQuery

The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.

iacSchemaDocumentQuery

Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.

iacValidateQuery

Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.

importMLModelConfigMutation

Import an ML model config from JSON or YAML. Requires mlmodelconfig:write permission.

knowledgeNoteQuery

Fetch a single knowledge note by ID. Requires knowledgeNote:read permission.

knowledgeNotesQuery

List knowledge notes with pagination and filtering. A direct query over the store; for situational relevance use `retrieveKnowledge`. Requires knowledgeNote:list permission.

latestMLModelConfigVersionQuery

Get the most recently trained version of an ML model config, published or not, with its holdout evaluation; null before the first successful training run. Requires mlmodelconfig:read permission.

listAIAdaptersQuery

List AI adapters with pagination and filtering. Requires aiadapter:list permission.

listAIAgentsQuery

List AI agents with pagination. Requires aiAgent:list permission.

listChatSessionsQuery

List your chat sessions with pagination and filtering. Listing only OPS sessions (filter context eq OPS) needs only a login; any other listing requires chatsession:list permission.

listDataChangeEventTopicsQuery

List all valid data change event topics, grouped by resource. Requires authentication.