embedded.factsAdded

Emitted when the embedded addFacts method is successfully called.

Event Properties

Field	Value
event	"embedded.factsAdded"
confidential	boolean
payload	object

Public Payload

Field	Type	Description
factCount	number	Number of facts being added
interactionId	string	Unique interaction identifier
interactionState	InteractionState	Current state of the interaction

Example

{
  "event": "embedded.factsAdded",
  "confidential": false,
  "payload": {
    "factCount": 2,
    "interactionId": "int_123",
    "interactionState": "ongoing"
  }
}

Confidential Payload

Field	Type	Description
factCount	number	Number of facts being added
facts	Fact[]	Array of facts with text, group, and source
interaction	ExternalInteraction	Interaction context including transcripts, documents, and facts

facts object properties

Field	Type	Description
text	string	-
group	string	-
source	"core" | "system" | "user" | undefined	-

interaction object properties

Field	Type	Description
id	string	Unique interaction identifier
title	string | null	Interaction title
state	InteractionState	Current state of the interaction
startedAt	string (ISO 8601 date)	When the interaction started (ISO 8601 date string)
transcriptCount	number	Number of transcripts in the interaction
documentCount	number	Number of documents in the interaction
facts	Fact[]	Facts extracted during the interaction

Fact properties:

Field	Type	Description
id	string	Unique fact identifier
text	string	Fact text content
group	string	Fact group/category name
source	"core" | "system" | "user"	Source of the fact: core (AI extracted), system, or user
isDiscarded	boolean	Whether the fact has been discarded

Example

{
  "event": "embedded.factsAdded",
  "confidential": true,
  "payload": {
    "factCount": 2,
    "facts": [
      {
        "text": "Chest pain",
        "group": "other",
        "source": "user"
      },
      {
        "text": "Shortness of breath",
        "group": "other",
        "source": "system"
      }
    ],
    "interaction": {
      "id": "int_123",
      "title": "Visit",
      "state": "ongoing",
      "startedAt": "2024-01-01T00:00:00.000+00:00",
      "transcriptCount": 0,
      "documentCount": 0,
      "facts": []
    }
  }
}