Skip to main content
PATCH
/
v1
/
transcript-evaluation
/
{evaluationID}
Update transcript evaluation
curl --request PATCH \
  --url https://analytics-api.voiceflow.com/v1/transcript-evaluation/{evaluationID} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "enabled": true,
  "prompt": "<string>",
  "settings": {
    "realtime": {
      "voice": "<string>",
      "eagerness": "<string>"
    },
    "maxTokens": 123,
    "temperature": 123
  },
  "truePrompt": "<string>",
  "falsePrompt": "<string>"
}
'

Authorizations

​
authorization
string
header
required

Voiceflow API key

Path Parameters

​
evaluationID
string
required

ID of the transcript evaluation to target.

Body

application/json
​
name
string

Name of the evaluation.

Required string length: 1 - 100
​
description
string | null

Description of the evaluation.

Maximum string length: 250
​
enabled
boolean

When enabled, evaluations will be run on every new transcript.

​
prompt
string

This prompt describes how the LLM should apply this evaluation.

Required string length: 1 - 10000
​
settings
object

The model settings passed when invoking this evaluation.

​
truePrompt
string

This prompt describes which transcripts should evaluate as 'true'.

Required string length: 1 - 10000
​
falsePrompt
string

This prompt describes which transcripts should evaluate as 'false'.

Required string length: 1 - 10000

Response

204 - undefined