Fetch & traces
A fetch is FACE’s main pipeline. It reads the selected data sources on a runner, profiles and
reconciles them, runs the posture, rules, hypothesis and twin agents on the sovereign model plane,
and returns one analysis with decisions, action cards and their judgements. FetchService starts
fetches, streams their progress, lists past runs, and generates procedures.
Fetches always execute on a runner, never on the control plane. The control plane checks the tenant’s compute budget, then hands the work to an enrolled runner or dials the managed runner (see Configuration, connections & runners). A fetch has no fixed compute-unit price: the model time it uses is metered per billing account (see Plans and billing). The compute budget checked first is the tenant’s self-managed ceiling (see Metering & schedules).
Summary
| Service | RPC | Kind | Purpose |
|---|---|---|---|
| FetchService | RunFetch | Unary | Run a fetch and return the analysis |
| FetchService | RunFetchStream | Server streaming | Run a fetch, streaming phase progress |
| FetchService | ListTraces | Unary | List saved sessions (order and claim workflows) |
| FetchService | GetTraceDetails | Unary | One run’s command, analysis and SQL |
| FetchService | GenerateSOP | Unary | Draft a standard operating procedure |
| FetchService | ListFetchStarters | Unary | Suggested fetch prompts |
| FetchService | ListFetchRuns | Unary | The fetch run history |
| FetchService | GetFetchAttachments | Unary | What one run read off its attachments |
| FetchService | GetRunStoryboard | Unary | One run’s question, strict verdict and storyboard |
| FetchService | GetAskLayout | Unary | One run’s Ask answer, block by block, as the run stored it |
| FetchService | GetScenarioGraph | Unary | One run’s scenarios as a mind map, shared leaves drawn once |
FetchService/GetDispatchKey is internal to the platform (served only by a runner, and only to a
verified mesh peer) and is not documented here.
FetchService
Full name semantics.v1.FetchService.
RunFetch
rpc RunFetch(RunFetchRequest) returns (RunFetchResponse);- Kind: Unary. A fetch can take many minutes: set a generous deadline, or use RunFetchStream.
- Auth: Bearer session, writer, admin or service account. A reader cannot run a fetch.
- Errors: None beyond authentication. Every outcome is in the response. Check
successandmessage:
| Situation | Response |
|---|---|
| Compute budget exhausted | success: false, message asks you to raise the dedicated Compute Units in Settings › Subscription. Nothing ran. |
| No runner available or reachable | success: false, message says so. The fetch never runs on the control plane. |
| No selected source could be read | success: false, message names each source and why. |
| Some analysis phases failed | success: false, message gives the verdict, and analysis carries what was produced. |
| Complete | success: true, transaction_id and analysis set. |
Read analysis.source_notices even on success: it reports sources that could not be read and
where SQL actually ran.
Request: RunFetchRequest
Shared by RunFetch and RunFetchStream.
| Field | Type | Description |
|---|---|---|
command | string | What to analyse, in plain language, for example Which shipments are running late, and why?. |
documents | repeated string | Attachments, each a data: URI with the file’s contents (data:<type>;name=<file name>;base64,<bytes>). The fetch reads each by what its bytes are, not by the declared type: photos (JPEG, PNG, TIFF, WebP), PDF (text layer and scanned pages), DOCX, PPTX, XLSX and plain text. Others are skipped with the reason. What it read is in analysis.attachments and GetFetchAttachments. |
connection_id | string | The primary data source. |
runner_id | string | The runner to use. The compute budget is always the tenant’s, whatever runner is named. |
enrichment_connection_ids | repeated string | Additional sources to read. |
trigger_type | RunFetchRequest.TriggerType | What started the run. |
schedule_config | string | Optional cron expression or description. |
job_id | string | Your job id. Used as the charge reference when there is no transaction id. |
language_preference | string | Preferred language for the analysis. |
notify_via_call | bool | Phone the carrier number in the integration config once every phase of the run has ended, not when the answer returns. The message says how the run ended: finished, partly finished (naming each phase that did not finish, and why), interrupted by a server restart, or failed. A finished run’s message adds the spoken summary. Sent once. Nothing is sent if no number is configured, or if the server stops before the run’s phases end. |
notify_via_whatsapp | bool | The same message as notify_via_call, at the same moment, to the WhatsApp number in the integration config. Nothing is sent if no number is configured. |
session_eda | bool | Run only the fast first phase (data domains, maturity, rules reconciliation, knowledge graph) and skip the deep hypothesis and twin agents. |
synapse_threshold | double | Minimum absolute Pearson r for the pass to record a measured link (“synapse”) between two data domains. 0 means the default, 0.5. Higher values give fewer, stronger links. |
dispatched_connections | repeated Connection | Internal. Set by the platform when it forwards work to a runner. A client value is overwritten or ignored. |
dispatch_id | string | Internal. As above. |
dispatched_credentials | repeated SealedCredential | Internal. As above. Clients never see or send credentials here. |
trigger_events | repeated DataEvent | Internal. Set by an event-triggered schedule: the change events that fired the run. A client value is cleared. |
trigger_connection_id | string | Internal. As above: the connection whose data listener saw them. |
persona_id | string | Who the run is for: a product persona’s id (ops, cfo, cro, cmo, ceo), a persona this instance saved, or empty for the generalist view. It changes what the answer leads with, never what data it reads. An id that names no persona is refused with INVALID_ARGUMENT. |
dispatched_persona, dispatched_external_search | Persona, ExternalSearchPolicy | Internal. The control plane overwrites both when it forwards work to a runner. A client cannot set them. |
public_sources | PublicSourceChoice (repeated string source_ids) | The public sources this run reads, by the ids ConfigService/ListPublicSources returns. Unset means the server’s default. Set means exactly those ids, and none when the list is empty. An id the server does not know is named on the run and read as nothing. It can only narrow what a run reads: the tenant’s external-search policy still decides what may leave. |
Response: RunFetchResponse
| Field | Type | Description |
|---|---|---|
success | bool | true only for a complete run. |
message | string | Why, when success is false. |
transaction_id | string | The run’s id, also used as the trace id. |
analysis | FetchAnalysisResult | The analysis. Also present on a partial run. |
RunFetchStream
rpc RunFetchStream(RunFetchRequest) returns (stream RunFetchUpdate);- Kind: Server streaming. Available over native gRPC and gRPC-web.
- Auth: Bearer session, writer, admin or service account. A reader cannot run a fetch.
- Errors: Outcomes arrive in the stream, as for
RunFetch. The stream can end with an error only if forwarding to the runner fails in transport.
Runs the same pipeline and streams real progress as each phase completes: data_health,
rules, scenarios, recommendations, and a terminal final event that carries the full
RunFetchResponse in result. A budget refusal is a single
denied event with done: true. An identical recent request may be answered straight from a
cache with one final event (“Answer ready (cached)”), and the result’s provenance then
says so.
The final event’s message is “Answer ready”: the answer is back, and the phases after it (the
analysis, which judges the scenarios, and the twins decisions) still run. It does not say the run
succeeded. Read the run’s verdict (ListFetchRuns,
GetRunStoryboard) for that.
Response: RunFetchUpdate
| Field | Type | Description |
|---|---|---|
phase | string | data_health, rules, scenarios, recommendations, final, or denied. |
message | string | Human-readable progress, for example Data health checked. |
done | bool | This phase, or for final and denied the whole run, is complete. |
result | RunFetchResponse | Set only on the final event. |
ListTraces
rpc ListTraces(ListTracesRequest) returns (ListTracesResponse);- Kind: Unary.
- Auth: Bearer session.
- Errors:
FAILED_PRECONDITIONif no session store is configured.INTERNALif it cannot be read.
Lists recent saved sessions, newest first. A session is saved only for order and claim workflows, so this is not a list of fetch runs: use ListFetchRuns for that.
Request: ListTracesRequest
| Field | Type | Description |
|---|---|---|
limit | int32 | Maximum runs. 0 or negative means 20. Capped at 200. |
Response: ListTracesResponse
| Field | Type | Description |
|---|---|---|
traces | repeated Trace | One per run. description is Cmd: <command> | <first 50 characters of the analysis>. |
GetTraceDetails
rpc GetTraceDetails(GetTraceDetailsRequest) returns (GetTraceDetailsResponse);- Kind: Unary.
- Auth: Bearer session.
- Errors:
UNAVAILABLEif no session store is configured.NOT_FOUNDif the trace does not exist.
Request: GetTraceDetailsRequest
| Field | Type | Description |
|---|---|---|
trace_id | string | A run’s transaction_id. |
Response: GetTraceDetailsResponse
| Field | Type | Description |
|---|---|---|
trace | Trace | The run. description holds the command, the full analysis and the generated SQL. |
GenerateSOP
rpc GenerateSOP(GenerateSOPRequest) returns (GenerateSOPResponse);- Kind: Unary.
- Auth: Bearer session.
- Errors:
INVALID_ARGUMENTif the request trips the prompt-injection check.PERMISSION_DENIEDif it trips the fetch agent’s guardrail.
Drafts a standard operating procedure in Markdown on the model plane. If the model is unavailable,
sop_content is SOP Generation Failed. That is not an error, so check the content.
Request: GenerateSOPRequest
| Field | Type | Description |
|---|---|---|
topic | string | What the procedure is for. |
process_name | string | The process. |
steps | repeated string | Optional step hints. |
Response: GenerateSOPResponse
| Field | Type | Description |
|---|---|---|
sop_content | string | The procedure, in Markdown. |
sop_id | string | sop_<unix seconds>. |
ListFetchStarters
rpc ListFetchStarters(ListFetchStartersRequest) returns (ListFetchStartersResponse);- Kind: Unary.
- Auth: Bearer session.
- Errors: None.
Returns four suggested prompts, sampled from the deployment’s configured list or from a built-in list.
Request: ListFetchStartersRequest
No fields.
Response: ListFetchStartersResponse
| Field | Type | Description |
|---|---|---|
starters | repeated FetchStarter | Suggestions. |
ListFetchRuns
rpc ListFetchRuns(ListFetchRunsRequest) returns (ListFetchRunsResponse);- Kind: Unary.
- Auth: Bearer session. The caller’s own runs; an org admin gets every run in the tenant.
- Errors:
UNAUTHENTICATEDwith no signed-in caller.FAILED_PRECONDITIONon a runner, or on a process that records no run history.UNAVAILABLEif the history cannot be read.
The fetch run history, newest first. The control plane records one run for every
RunFetch and RunFetchStream call it receives from a signed-in caller, including
fetches it refuses. A run carries no result. Its verdict carries the question it was
asked and which of its phases finished (see RunVerdict).
A run is recorded twice: as FETCH_RUN_OUTCOME_RUNNING when the control plane receives
it, and with its outcome when it answers. Both records share run_id, and the
response lists the run once, with the later outcome. If the control plane stops before
the run answers, no outcome is ever recorded. Such a run is listed as
FETCH_RUN_OUTCOME_INTERRUPTED once it is older than the 300-second fetch limit plus
a 60-second margin, with ended_unix_ms 0 and a message saying the server stopped
before it finished. Before that it is listed as running. With object storage
configured, runs are kept for 30 days; without it, the newest 500 records (a run’s
start and end are two) are kept in memory and lost on a restart.
A run is successful only when every phase finished, including the phases that run
after the answer. outcome says only whether the response came back; read verdict
for whether the run succeeded.
Request: ListFetchRunsRequest
| Field | Type | Description |
|---|---|---|
limit | int32 | Maximum runs. 0 or negative means 20. Capped at 200. |
include_archived | bool | Also list archived runs, each marked archived, so they can be restored. Org admin only: anyone else is refused. |
Response: ListFetchRunsResponse
| Field | Type | Description |
|---|---|---|
runs | repeated FetchRunSummary | Newest first. |
durable | bool | False when the history is kept in memory only. |
not_durable_reason | string | Why, when durable is false. |
GetFetchAttachments
rpc GetFetchAttachments(GetFetchAttachmentsRequest) returns (GetFetchAttachmentsResponse);- Kind: Unary.
- Auth: Bearer session. Only the tenant that ran the fetch can read its readings.
- Errors:
INVALID_ARGUMENTwhentransaction_idis missing or is not a fetch run.NOT_FOUNDwhen the run recorded no readings (it ran before readings were recorded, or they could not be stored).UNAVAILABLEif the readings cannot be read.
What one fetch read off the attachments it was sent, in the order sent. The same list is on
that run’s analysis.attachments. Every run records its list, so a run sent no attachment
answers an empty list, not NOT_FOUND.
Request: GetFetchAttachmentsRequest
| Field | Type | Description |
|---|---|---|
transaction_id | string | The run, as FetchRunSummary.transaction_id. Required. |
Response: GetFetchAttachmentsResponse
| Field | Type | Description |
|---|---|---|
transaction_id | string | The run. |
attachments | repeated FetchAttachmentReading | One per attachment. Empty when the run was sent none. |
GetRunStoryboard
rpc GetRunStoryboard(GetRunStoryboardRequest) returns (RunStoryboard);- Kind: Unary.
- Auth: Bearer session. Only a run in the caller’s own run history (an org admin’s: the tenant’s).
- Errors:
INVALID_ARGUMENTwith notransaction_id.UNAUTHENTICATEDwith no signed-in caller.FAILED_PRECONDITIONon a runner, or on a process that records no run history.NOT_FOUNDwhen the run is not in the caller’s history.UNAVAILABLEif the history cannot be read.
One run’s storyboard: its question and strict verdict, and what each page of the
story recorded for it, read from that run’s own records. A count is set only with its
*_recorded (or rows_stated) flag: false means the run recorded nothing for that
page, not zero.
Request: GetRunStoryboardRequest
| Field | Type | Description |
|---|---|---|
transaction_id | string | The run’s analysis transaction id. |
Response: RunStoryboard
| Field | Type | Description |
|---|---|---|
transaction_id | string | The run. |
verdict | RunVerdict | Its strict verdict. Absent for a run that answered before its phases were recorded. |
datasets_read | int32 | Fetch: the datasets read for the question. |
rows_read | int64 | Fetch: the rows read, when rows_stated. |
rows_stated | bool | True when the fetch stated its row count. |
knowledge_recorded | bool | True when the run recorded a posture or rules. |
domains | int32 | Knowledge: the domains in its posture. |
rules | int32 | Knowledge: the rules it recorded. |
scenarios_recorded | bool | True when the run recorded scenario results. |
scenarios_judged | int32 | Scenarios: the scenarios judged. |
twins_recorded | bool | True when the run recorded decisions or actions. |
decisions | int32 | Twins: the decisions recorded. |
actions | int32 | Twins: the actions recorded. |
started_unix_ms | int64 | When the control plane received the run. |
GetAskLayout
rpc GetAskLayout(GetAskLayoutRequest) returns (AskLayout);- Kind: Unary.
- Auth: Bearer session. Only a run in the caller’s own run history (an org admin’s: the tenant’s).
- Errors:
INVALID_ARGUMENTwith notransaction_id.UNAUTHENTICATEDwith no signed-in caller.FAILED_PRECONDITIONon a runner, or on a process that records no run history.NOT_FOUNDwhen the run is not in the caller’s history, or stored no layout (it ran before layouts were stored, or its twins phase has not ended).UNAVAILABLEif the history or the layout cannot be read.DATA_LOSSif the stored layout cannot be decoded.
One run’s Ask answer as the run stored it: the blocks the model chose for the question, in its order, each resolved by the server from what the run measured. It is read back, never asked again: no model call. See Ask.
Request: GetAskLayoutRequest
| Field | Type | Description |
|---|---|---|
transaction_id | string | The run’s analysis transaction id. |
Response: AskLayout
| Field | Type | Description |
|---|---|---|
transaction_id | string | The run. |
source | AskLayoutSource | MODEL: the model chose the blocks. DEFAULT: the fixed layout (the answer, then what waits) stands in. |
fallback_reason | string | Why the fixed layout stands in. Empty for MODEL. |
blocks | repeated AskBlock | In order. Each has a state (PRESENT, EMPTY with state_reason, or UNREADABLE with the read’s error), a basis (where it was read, over which tables, sampled or not, how) and one of answer, figure, table, chart, map_layer, decision_options, actions, evidence or not_checked. |
dropped | repeated AskDroppedBlock | Blocks the model named that the run does not hold, each with why. |
resolved_unix_ms | int64 | When the layout was resolved. |
GetScenarioGraph
rpc GetScenarioGraph(GetScenarioGraphRequest) returns (ScenarioGraph);- Kind: Unary.
- Auth: Bearer session. Only a run in the caller’s own run history (an org admin’s: the tenant’s).
- Errors:
UNAUTHENTICATEDwith no signed-in caller.FAILED_PRECONDITIONon a runner, or on a process that records no run history.NOT_FOUNDwhen the run is not in the caller’s history.UNAVAILABLEwhen one of the run’s records cannot be read: the graph is then unknown, never empty.
The graph behind Graph on the Options page: the run’s question, its business areas, their
scenarios, and what each scenario rests on, read from the run’s stored records with no
model call. Node kinds: RUN (or ESTATE when no run is named: the caller’s newest
run), DOMAIN, SCENARIO, PROPERTY (a lever its simulation tested), EDGE_TEST
(the link between two areas a synapse scenario crosses), TERM (a metasearch topic or
market subject), TABLE, RULE and VERDICT. A node is identified by the record’s own
key (term:<normalised term>, rule:<rule id>, table:<table>, edge:<a>|<b>), so a
leaf several scenarios share is one node with an edge from each; what differs per
scenario (a property’s result, the terms a scenario triggered across an edge test) is
on the edge. A kind the run recorded nothing for is listed in gaps with the reason.
Request: GetScenarioGraphRequest
| Field | Type | Description |
|---|---|---|
transaction_id | string | The run. Empty: the caller’s newest run, under an ESTATE root. |
Response: ScenarioGraph
| Field | Type | Description |
|---|---|---|
transaction_id | string | The run read; empty when the caller has none. |
root_id | string | The root node. |
nodes | repeated ScenarioGraphNode | id, kind, label (the record’s own text), scenario_id and domain for a scenario, status, facts (key and value), sources and ran_at for a term, and measured with not_measured_reason. |
edges | repeated ScenarioGraphEdge | from_id, to_id, the link’s facts, and triggered_terms on a scenario → edge-test link. |
gaps | repeated ScenarioGraphGap | A node kind the run recorded nothing for, and why. |
run_verdict | RunVerdict | The run’s strict verdict, when it recorded one. |
computed_unix_ms | int64 | When the graph was built (kept for 5 s per tenant and run). |
Messages
FetchAttachmentReading
One attachment, as one fetch read it. status and found_content together give three
states: read with something on it, read with nothing on it (READ, found_content false),
and not readable (SKIPPED or FAILED).
| Field | Type | Description |
|---|---|---|
index | int32 | 1-based position in the request’s documents. |
name | string | The file name the client sent, else attachment N. Never a server path. |
content_type | string | Detected from the bytes, for example application/pdf. |
status | FetchAttachmentStatus | FETCH_ATTACHMENT_STATUS_READ, FETCH_ATTACHMENT_STATUS_SKIPPED (not a format a fetch reads, such as a recording or an archive) or FETCH_ATTACHMENT_STATUS_FAILED (a format a fetch reads, and reading it failed). |
reason | string | Why it was skipped, or the error it failed with. Empty when read. |
text | string | The text read off it, at most 64 KiB. |
text_truncated | bool | The text was cut. |
found_content | bool | Anything was read: text, a field or a table. |
documents | repeated StructuredDocument | The structured reading of each photo the attachment is, or carries as a scanned PDF page: document type, fields with boxes, tables, checkboxes and warnings, as OCRService.ExtractStructured returns them. Each is stored, so SaveStructuredCorrections and ExportStructured accept its document_id. |
tables | repeated FetchAttachmentTable | Tables the document declares (DOCX, PPTX, XLSX) or that a PDF’s text layer lays out: name, columns, rows (at most 200, truncated when more), method (native or text-layer) and note. |
notes | repeated string | What part of a read attachment was left out, and why. |
pages_read, pages_total | int32 | For a PDF: pages read, and pages in the document. 0 otherwise. |
FetchRunSummary
| Field | Type | Description |
|---|---|---|
run_id | string | An id the control plane assigns when the run arrives. Runs recorded before the start record existed carry the analysis transaction id instead. |
started_unix_ms | int64 | When the control plane received the run. |
ended_unix_ms | int64 | When its answer left. 0 for a running or interrupted run. |
outcome | FetchRunOutcome | FETCH_RUN_OUTCOME_SUCCEEDED, FETCH_RUN_OUTCOME_FAILED, FETCH_RUN_OUTCOME_DENIED (refused before any runner was used), FETCH_RUN_OUTCOME_RUNNING (received, no answer yet) or FETCH_RUN_OUTCOME_INTERRUPTED (never answered; the server stopped first). |
message | string | The failure or refusal message, clipped to 240 characters. For an interrupted run, a sentence saying the server stopped before the run finished. |
runner_id | string | The runner the request named; empty when it named none. |
transaction_id | string | The analysis transaction id the response carried. Empty while running, for a refused or interrupted run, or when the response had none. A cached answer repeats an earlier run’s transaction id. |
verdict | RunVerdict | The run’s strict verdict. Absent for a run that answered before its phases were recorded: such a run is not successful. |
verdict_unreadable | string | Set when the run’s phase ledger could not be read, in the server’s words. verdict is then absent because nothing was read, which is not the same as a run that recorded no ledger. |
archived, archived_by, archived_unix_ms | bool, string, int64 | Set only with include_archived: the run is archived, by whom (the verified subject) and when. |
persona_id, persona_name | string | Who the run was made for, and that persona’s name when the run arrived. Both empty for the generalist view. |
RunVerdict
| Field | Type | Description |
|---|---|---|
outcome | RunVerdictOutcome | How the run ended, strictly. |
phases | repeated RunPhase | Every phase the run planned, in order: the fetch’s own, then the ones after the answer. |
question | string | The question the run was asked, up to 500 characters. |
RunPhase
| Field | Type | Description |
|---|---|---|
phase | string | sources, data_prep, trends, analysis, scenarios, twins, or another phase the fetch budget planned. |
label | string | The fetch budget’s label for the phase. |
status | string | done, failed, overrun, skipped, running or not_run. Only done counts as finished. |
reason | string | Why it did not finish, in the server’s words. Empty when it did. |
elapsed_ms | int64 | How long it took, when measured. |
stage | string | fetch (before the answer) or background (after it). |
FetchAnalysisResult
| Field | Type | Description |
|---|---|---|
transaction_id | string | Run id. |
sql_generated | string | The SQL the pipeline generated and ran. |
quality | DataQuality | Not measured by the current pipeline: every figure is 0. See metrics.unmeasured_reason. |
profiling | DataProfiling | Only data_shapes is set, and it is a fixed label. The other fields are empty. |
metrics | EvaluationMetrics | No evaluation harness runs for a fetch: unmeasured_reason is set and every score is absent. Do not display them. |
graph_nodes | repeated KnowledgeGraphNode | The domain graph. |
graph_edges | repeated KnowledgeGraphEdge | Its edges, with the evidence in relation. |
analysis_text | string | The business analysis, as prose. |
decisions | repeated Decision | The twin’s decisions. |
action_cards | repeated ActionCard | Proposed actions, with origin stage fetch. Decide them with TwinsService/ExecuteAction. |
time_series | repeated TimeSeriesInsight | Time-series insights. |
shadow_search | repeated ShadowSearchResult | Public research used. |
spoken_response | string | A short spoken-style summary. |
provenance | Provenance | How this result was produced: fresh, cached, or degraded. |
hypothesis_scenarios | repeated DecisionScenario | The hypothesis swarm’s scenarios. A union of independent agents’ answers, not a consensus. |
hypothesis_impacts | repeated ImpactSimulation | Swarm impacts. |
hypothesis_traces | repeated EvidenceTrace | Swarm evidence traces. |
hypothesis_forecasts | repeated TimeSeriesForecast | Swarm forecasts. |
hypothesis_anomalies | repeated TimeSeriesAnomaly | Swarm anomalies. |
hypothesis_scenarios_inferred | int32 | Scenarios the estate proposed before the agent cap. Meaningful only when hypothesis_swarm_ran is true. |
hypothesis_agents_dispatched | int32 | Agents started. Fewer than inferred means the lists above are a sample. |
hypothesis_agents_succeeded | int32 | Agents that produced a simulation. |
hypothesis_swarm_ran | bool | Whether the three counts above were measured. false means they are absent, not zero: for example on a session_eda fetch. |
source_notices | repeated string | Sentences about sources that could not be read, or about where a source’s SQL ran. Empty does not mean everything was fine. |
action_judgements | JudgementSet | The verdict on every action proposed in this run, accepted and rejected. Rejected actions appear nowhere else. |
attachments | repeated FetchAttachmentReading | What this run read off each attachment it was sent: read, skipped (with the reason) or failed (with the error). Empty when it was sent none. |
DataQuality
| Field | Type | Description |
|---|---|---|
accuracy | double | Accuracy. |
completeness | double | Completeness. |
consistency | double | Consistency. |
timeliness | double | Timeliness. |
validity | double | Validity. |
uniqueness | double | Uniqueness. |
integrity | double | Integrity. |
relevance | double | Relevance. |
DataProfiling
| Field | Type | Description |
|---|---|---|
outliers | repeated string | Outliers. |
patterns | repeated string | Patterns. |
schema_drifts | repeated string | Schema drifts. |
data_shapes | string | Data shapes. |
duplicate_rows | int32 | Duplicate rows. |
Provenance
| Field | Type | Description |
|---|---|---|
path | string | How the result was reached, for example exact-cache, near-dup or full. |
model | string | The model that produced it. Empty for a cache or deterministic result. |
source | string | fresh, exact-cache, near-dup or offline. |
degraded | bool | Produced without full server capability. |
confidence | double | Judge score or near-duplicate similarity, 0 to 1. |
computed_at | int64 | Unix seconds when the underlying value was produced. Use it to judge staleness. |
Trace
| Field | Type | Description |
|---|---|---|
id | string | The run’s transaction id. |
schema_name | string | Always execution_log. |
table_name | string | Always session_result. |
row_count | int64 | Not populated. |
size_bytes | int64 | Not populated. |
last_modified | string | When the run was recorded, RFC 3339. |
description | string | The run’s command and analysis. See each RPC. |
freshness_label | string | Not populated. |
columns | repeated string | Not populated. |
downstream_tables | repeated string | Not populated. |
FetchStarter
| Field | Type | Description |
|---|---|---|
icon | string | Icon name. |
title | string | Title. |
subtitle | string | Subtitle. |
prompt_text | string | The prompt to send as RunFetchRequest.command. |
Enums
RunVerdictOutcome
| Value | Meaning |
|---|---|
RUN_VERDICT_OUTCOME_UNSPECIFIED | Not set. |
RUN_VERDICT_OUTCOME_SUCCESSFUL | It answered, and every phase is done. |
RUN_VERDICT_OUTCOME_PARTIAL | It answered, and at least one phase is not done. A phase left running more than 46 minutes after the run’s last update reads as not_run, with the reason the server stopped before it finished. |
RUN_VERDICT_OUTCOME_FAILED | It did not answer: it failed, was refused or was interrupted. |
RUN_VERDICT_OUTCOME_RUNNING | It has not answered yet, or a phase after the answer is running. |
RunFetchRequest.TriggerType
| Value | Meaning |
|---|---|
TRIGGER_TYPE_UNSPECIFIED | Not set. |
TRIGGER_TYPE_MANUAL | Started by a person. |
TRIGGER_TYPE_SCHEDULED | Started by a schedule. |
TRIGGER_TYPE_API | Started by an integration. |
TRIGGER_TYPE_EVENT | Started by an event-triggered schedule, when a connection’s data listener saw the changes it asks for. |