AI & ML
Aiml
Explore the data types and operations available in Aiml.
88 operations
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.
captureKnowledgeMutationCapture 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.
chatAIAvailabilityQueryReport 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.
chatMessageStreamSubscriptionStream 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.
clearChatMessagesMutationClear all messages from a chat session. Requires chatsession:write permission.
compileSchemaXMLQueryCompile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
conceptQueryFetch a single concept by ID. Requires concept:read permission.
conceptsQueryList the tenant's concepts with pagination. Requires concept:list permission.
confirmKnowledgeNoteMutationEndorse a note: increments its confirmation count (raising its retrieval trust weight) and promotes a PENDING note to LIVE. Requires knowledgeNote:write permission.
createAIAdapterMutationCreate a new AI adapter. Requires aiadapter:write permission.
createAIAgentMutationCreate a new AI agent. Requires aiAgent:write permission.
createChatSessionMutationCreate a new chat session. An OPS session needs only a login; any other context requires chatsession:write permission.
createConceptMutationManually author a concept in the ontology. Requires concept:write permission.
createKnowledgeNoteMutationContribute a knowledge note about a concept or an entity. Requires knowledgeNote:write permission.
createMLExperimentMutationStart a personal ML experiment, blank or from an existing model's XML. Requires mlmodelconfig:execute permission and a signed-in user.
createMLModelConfigMutationCreate a new ML model config. Requires mlmodelconfig:write permission.
dataChangeEventsSubscriptionSubscribe 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).
deleteAIAdapterMutationDelete an AI adapter. Requires aiadapter:delete permission.
deleteAIAgentMutationDelete an AI agent. Requires aiAgent:delete permission.
deleteChatSessionMutationDelete a chat session. Requires chatsession:delete permission.
deleteConceptMutationDelete a concept. Requires concept:delete permission.
deleteKnowledgeNoteMutationDelete a note and any graph edges it sourced. Requires knowledgeNote:delete permission.
deleteMLExperimentMutationDelete one of your ML experiments with its runs and their models. Requires mlmodelconfig:execute permission and a signed-in user.
deleteMLModelConfigMutationDelete an ML model config. Requires mlmodelconfig:delete permission.
describeQuerySchemaQueryAnalyze 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.
exportMLModelConfigQueryExport an ML model config as JSON or YAML. Requires mlmodelconfig:read permission.
forecastMLExperimentRunMutationTry 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.
forecastMLModelMutationForecast future values using a trained time-series model. Requires mlmodelconfig:execute permission.
generateDefaultDataQueryQueryGenerate 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.
getAIAdapterQueryFetch an AI adapter by ID. Requires aiadapter:read permission.
getAIAgentQueryFetch an AI agent by ID. Requires aiAgent:read permission.
getChatSessionQueryFetch one of your chat sessions by ID. Your own OPS sessions need only a login; any other session requires chatsession:read permission.
getMagicQueryGraphQLQueryResolves 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.
getMagicQuerySchemaQueryReturns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
getMLModelConfigQueryFetch an ML model config by ID. Requires mlmodelconfig:read permission.
getMLModelConfigVersionQueryGet a specific ML model config version by ID. Requires mlmodelconfig:read permission.
helpChapterQueryRead a chapter of the current published manual edition.
helpChaptersQueryList human-facing manual chapters from the running deployment.
iacGuidesQueryEvery 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.
iacSchemaQueryThe infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacSchemaDocumentQueryFetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
iacValidateQueryValidate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
importMLModelConfigMutationImport an ML model config from JSON or YAML. Requires mlmodelconfig:write permission.
knowledgeNoteQueryFetch a single knowledge note by ID. Requires knowledgeNote:read permission.
knowledgeNotesQueryList knowledge notes with pagination and filtering. A direct query over the store; for situational relevance use `retrieveKnowledge`. Requires knowledgeNote:list permission.
latestMLModelConfigVersionQueryGet 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.
listAIAdaptersQueryList AI adapters with pagination and filtering. Requires aiadapter:list permission.
listAIAgentsQueryList AI agents with pagination. Requires aiAgent:list permission.
listChatSessionsQueryList 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.
listDataChangeEventTopicsQueryList all valid data change event topics, grouped by resource. Requires authentication.