@@ -38005,59 +38005,79 @@ components:
3800538005 type: string
3800638006 description: The text of the matched guidance rule.
3800738007 example: If the customer asks about pricing, ask which plan they're interested in before answering
38008- ai_topic_subtopic_list :
38008+ ai_topic_subtopic :
3800938009 title: AI Topic and Subtopic
38010- type: array
38011- readOnly: true
38012- description: The topics Fin detected in a conversation, returned under the "AI
38013- Topic and Subtopic" key of a conversation's custom attributes. Generated by
38014- Fin and returned in responses only; it cannot be set on a request.
38015- items:
38016- type: object
38017- properties:
38018- topic_name:
38019- type: string
38020- description: The name of the topic.
38021- example: Billing
38022- subtopic_name:
38023- type: string
38024- nullable: true
38025- description: The name of the subtopic, where the topic has one.
38026- example: Refund request
38027- id:
38028- type: integer
38029- nullable: true
38030- description: The unique identifier for the subtopic.
38031- example: 12345
38032- cx_score_reason_list:
38033- title: CX Score reasons
38034- type: array
38035- readOnly: true
38036- description: The reasons behind a conversation's CX Score, returned under the
38037- "CX Score reasons" key of a conversation's custom attributes. Generated by
38038- Fin and returned in responses only; it cannot be set on a request.
38039- items:
38040- type: object
38041- properties:
38042- name:
38043- type: string
38044- description: The name of the reason.
38045- example: Resolution speed
38046- value:
38047- type: string
38048- description: The value recorded for the reason.
38049- example: Fast
38010+ type: object
38011+ description: >-
38012+ A single AI-generated topic and subtopic classification for a
38013+ conversation. Surfaced inside `custom_attributes` under the "AI Topic
38014+ and Subtopic" key as an array of these objects. Requires the AI add-on;
38015+ the key is omitted when the conversation has no classification.
38016+ properties:
38017+ topic_name:
38018+ type: string
38019+ description: The name of the AI-generated topic.
38020+ example: Billing
38021+ subtopic_name:
38022+ type: string
38023+ nullable: true
38024+ description: The name of the AI-generated subtopic, if any.
38025+ example: Payment Issues
38026+ id:
38027+ type: integer
38028+ nullable: true
38029+ description: The id of the subtopic.
38030+ example: 42
38031+ cx_score_reason:
38032+ title: CX Score reason
38033+ type: object
38034+ description: >-
38035+ A single reason behind a conversation's CX Score. Surfaced inside
38036+ `custom_attributes` under the "CX Score reasons" key as an array of
38037+ these objects.
38038+ properties:
38039+ name:
38040+ type: string
38041+ description: The name of the reason.
38042+ example: Resolution speed
38043+ value:
38044+ type: string
38045+ description: The value recorded for the reason.
38046+ example: Fast
3805038047 custom_attributes:
3805138048 title: Custom Attributes
3805238049 type: object
38053- description: An object containing the different custom attributes associated
38054- to the conversation as key-value pairs. For relationship attributes the value
38055- will be a list of custom object instance models. Attributes that Intercom
38056- generates — such as "CX Score rating", "CX Score explanation", "AI
38057- Topic and Subtopic" and "CX Score reasons" — may also be included. Two of
38058- them, "AI Topic and Subtopic" and "CX Score reasons", carry lists of objects
38059- as their values, and are returned in responses only — they cannot be set on
38060- a write request.
38050+ description: >-
38051+ An object containing the custom attributes on a conversation as key-value
38052+ pairs. For relationship attributes the value is a list of custom object
38053+ instance models. System-defined attributes such as "CX Score rating",
38054+ "CX Score explanation" and "CX Score reasons" may also be included.
38055+ properties:
38056+ "AI Topic and Subtopic":
38057+ type: array
38058+ readOnly: true
38059+ description: >-
38060+ Read-only AI Insights classification of the conversation. Present
38061+ only with the AI add-on; omitted when the conversation has no
38062+ classification.
38063+ example:
38064+ - topic_name: Billing
38065+ subtopic_name: Payment Issues
38066+ id: 42
38067+ items:
38068+ "$ref": "#/components/schemas/ai_topic_subtopic"
38069+ "CX Score reasons":
38070+ type: array
38071+ readOnly: true
38072+ description: >-
38073+ Read-only reasons behind the conversation's CX Score. Intercom
38074+ generates this attribute, so it cannot be set. Omitted when the
38075+ conversation has no CX Score reasons.
38076+ example:
38077+ - name: Resolution speed
38078+ value: Fast
38079+ items:
38080+ "$ref": "#/components/schemas/cx_score_reason"
3806138081 additionalProperties:
3806238082 anyOf:
3806338083 - type: string
@@ -38066,8 +38086,6 @@ components:
3806638086 - type: boolean
3806738087 - $ref: "#/components/schemas/datetime"
3806838088 - "$ref": "#/components/schemas/custom_object_instance_list"
38069- - "$ref": "#/components/schemas/ai_topic_subtopic_list"
38070- - "$ref": "#/components/schemas/cx_score_reason_list"
3807138089 example:
3807238090 paid_subscriber: true
3807338091 monthly_spend: 155.5
@@ -38079,8 +38097,8 @@ components:
3807938097 expressed satisfaction with the outcome.
3808038098 AI Topic and Subtopic:
3808138099 - topic_name: Billing
38082- subtopic_name: Refund request
38083- id: 12345
38100+ subtopic_name: Payment Issues
38101+ id: 42
3808438102 CX Score reasons:
3808538103 - name: Resolution speed
3808638104 value: Fast
0 commit comments