A single deployment conversation message.
| KEY | TYPE | Description |
|---|---|---|
| role | str | The role of the message sender |
| text | str | The text of the message |
| timestamp | str | The timestamp at which the message was sent |
| messageIndex | int | The index of the message in the conversation |
| regenerateAttempt | int | The sequence number of regeneration. Not regenerated if 0. |
| modelVersion | str | The model instance id associated with the message. |
| searchResults | dict | The search results for the message. |
| isUseful | bool | Whether this message was marked as useful or not |
| feedback | str | The feedback provided for the message |
| feedbackType | str | The type of feedback provided for the message |
| docInfos | list | A list of information on the documents associated with the message |
| keywordArguments | dict | User message only. A dictionary of keyword arguments used to generate response. |
| inputParams | dict | User message only. A dictionary of input parameters used to generate response. |
| attachments | list | A list of attachments associated with the message. |
| responseVersion | str | The version of the response, used to differentiate w/ legacy agent response. |
| agentWorkflowNodeId | str | The workflow node id associated with the agent response. |
| nextAgentWorkflowNodeId | str | The id of the workflow node to be executed next. |
| chatType | str | The type of chat llm that was run for the message. |
| agentResponse | dict | Response from the agent. Only for conversation with agents. |
| error | str | The error message in case of an error. |
| segments | list | The segments of the message. |
| streamedData | str | Aggregated streamed messages from the agent. |
| streamedSectionData | str | Aggregated streamed section outputs from the agent in a list. |
| highlights | dict | Chunks with bounding boxes for highlighting the result sources. |
| llmDisplayName | str | The display name of the LLM model used to generate the response. Only used for system-created bots. |
| llmBotIcon | str | The icon location of the LLM model used to generate the response. Only used for system-created bots. |
| formResponse | dict | Contains form data response from the user when a Form Segment is given out by the bot. |
| routedLlm | str | The LLM that was chosen by RouteLLM to generate the response. |
| computePointsUsed | int | The number of compute points used for the message. |
| computerFiles | list | The list of files that were created by the computer agent. |
| toolUseRequest | dict | The tool use request for the message. |
| verificationSummary | str | The summary of the verification process for the message. |
| attachedUserFileNames | list | The list of files attached by the user on the message. |
| oldFileContent | str | The content of the file associated with an edit tool request before the file was edited |
| allVersions | list | All versions of the last bot message for version switching functionality. |
| selectedVersionIndex | int | The index of the currently selected version of the last bot message. |
| totalVersions | int | The total number of versions available for the last bot message. |
| isLastMessage | bool | Whether this message is the last message in the conversation. |