Analysis
One analyzer run over a Call (1.56.0; call-lifecycle-hooks-and-events.md section 3.9): its status, analyzer version, input, Provider, fields and the values this read may answer, usage and timing.
An object with 19 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
advisory | boolean | yes | True when a judge produced the result and has not passed its calibration (section 3.5); false for summary and outcomes. |
analysis_ms | integer or null | yes | How long the analyzer ran, a measurement; null until settled. |
analyzer | AnalyzerRef | yes | |
call_id | CallId | yes | |
completed_at | Timestamp or null | yes | When it settled; null before. |
created_at | Timestamp | yes | |
environment | Environment | yes | |
error_code | string or null | yes | Why it failed or was skipped, such as transcript_unavailable; else null. |
fields | map of AnalysisField | yes | The output fields with their types and phi flags; configuration. |
id | AnalysisId | yes | |
input | AnalysisInputFacts | yes | |
job_id | JobId or null | yes | The call.analyze job that runs it. |
object | "analysis" | yes | |
provider | AnalysisProvider or null | yes | Null before the run. |
run | integer | yes | |
scrubbed_at | Timestamp or null | yes | When the retention scrub nulled the values with the Call; null before. |
status | AnalysisStatus | yes | |
usage | AnalysisUsage or null | yes | Null until settled. |
values | AnalysisValues or null | yes | The values this read may answer: those of phi: false fields of a type that is not free text, and with include=values every value. Null until completed, and once scrubbed. |
Used by
The operations whose parameters, request body or responses name this shape directly.