Enrichment Status

Get tenant enrichment status

client.enrichmentStatus.retrieve(, ?): EnrichmentStatusRetrieveResponse { as_of, emotions, sentiment, 2 more }

GET/v1/enrichment-status

ModelsExpand Collapse

TypeStatus { done, eligible, enabled, 3 more }

One enrichment's progress for a tenant. When enabled is false, eligible and done are zero.

done: number

Eligible records that have been enriched.

formatint64

eligible: number

Feedback records that qualify for this enrichment.

formatint64

enabled: boolean

Whether the enrichment is active for the tenant (deployment-configured and switched on / with a resolvable target language).

failed: number

Eligible records whose last enrichment attempt gave up but which a retry could still rescue — a provider outage, a timeout. Counted only while the record is still un-enriched, so a later success removes it without any cleanup.

formatint64

failed_terminal: number

Eligible records the provider will never accept, because the outcome is a property of the record's own text — a content-policy block, a refusal, an input past the model's limit. Retrying these cannot help; they resolve only if the text changes.

formatint64

disabled_reason?: "not_configured" | "switched_off" | "no_target_language"

Which gate switched the enrichment off. Present exactly when enabled is false, and absent otherwise. not_configured — the deployment has no provider/model for this enrichment, so it is off for every tenant and only an operator can fix it. switched_off — the tenant turned it off (sentiment and emotions only). no_target_language — translation is configured but neither the tenant's target_language nor the deployment default resolves (translation only; it has no on/off switch, so an absent target is its off state).

Accepts one of the following:

"not_configured"

"switched_off"

"no_target_language"