Skip to content

Document readable evaluator fields on QA scorecards (Preview) #683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
s-harding wants to merge 2 commits into
base: main
Choose a base branch
from
+53 −0
Open

Document readable evaluator fields on QA scorecards (Preview) #683

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9784524
Document readable evaluator fields on QA scorecards (Preview)
s-harding Sep 24, 2026
386643a
Show reasons in the scorecard evaluator examples
s-harding Sep 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions descriptions/0/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12515,10 +12515,18 @@ paths:
body: Great empathy in the second reply.
evaluators:
- evaluator_id: '54321'
name: Tone of voice
result:
value: pass
value_label: Pass
source: ai
reasoning: The agent acknowledged the issue and resolved it within the same response.
reason_ids:
- '101'
- '102'
reasons:
- name: Clear and concise
- name: Empathetic tone
schema:
"$ref": "#/components/schemas/conversation_list"
'401':
Expand Down Expand Up @@ -13227,10 +13235,18 @@ paths:
body: Great empathy in the second reply.
evaluators:
- evaluator_id: '54321'
name: Tone of voice
result:
value: pass
value_label: Pass
source: ai
reasoning: The agent acknowledged the issue and resolved it within the same response.
reason_ids:
- '101'
- '102'
reasons:
- name: Clear and concise
- name: Empathetic tone
schema:
"$ref": "#/components/schemas/conversation"
'404':
Expand Down Expand Up @@ -13969,10 +13985,18 @@ paths:
body: Great empathy in the second reply.
evaluators:
- evaluator_id: '54321'
name: Tone of voice
result:
value: pass
value_label: Pass
source: ai
reasoning: The agent acknowledged the issue and resolved it within the same response.
reason_ids:
- '101'
- '102'
reasons:
- name: Clear and concise
- name: Empathetic tone
schema:
"$ref": "#/components/schemas/conversation_list"
requestBody:
Expand Down Expand Up @@ -33726,6 +33750,11 @@ components:
type: string
description: The unique identifier of the evaluator (criterion) within the scorecard.
example: '54321'
name:
type: string
nullable: true
description: The name of the evaluator (criterion). Null if the evaluator's name could not be resolved.
example: Tone of voice
result:
allOf:
- "$ref": "#/components/schemas/conversation_scorecard_evaluator_result"
Expand All @@ -33743,6 +33772,10 @@ components:
nullable: true
description: The evaluator's selected value (typically a label such as `pass`, `fail`, or a category identifier).
example: pass
value_label:
type: string
description: The label of the rating option matching `value` (for example `Needs improvement`). Omitted when the label could not be resolved.
example: Pass
source:
type: string
nullable: true
Expand All @@ -33762,11 +33795,31 @@ components:
example:
- '101'
- '102'
reasons:
type: array
description: The names of the structured reasons in `reason_ids`, one entry per id, in the same order. Omitted when the result has no `reason_ids`.
items:
"$ref": "#/components/schemas/conversation_scorecard_evaluator_reason"
example:
- name: Clear and concise
- name: Empathetic tone
other_text:
type: string
nullable: true
description: Free-text entered by the reviewer to supplement or stand in for the structured `reason_ids` — typically captured when the reviewer selects an "Other" option or adds a custom note. Null when not provided.
example: Agent acknowledged the issue but missed the follow-up question about billing.
conversation_scorecard_evaluator_reason:
title: Evaluator Reason
type: object
x-tags:
- Conversations
description: A single structured reason assigned to an evaluator's result.
properties:
name:
type: string
nullable: true
description: The name of the reason. Null if the reason's name could not be resolved.
example: Clear and concise
conversation_channel:
title: Conversation Channel
type: object
Expand Down
Loading