Skip to content

Commit e8f4e31

Browse files
authored
Update genai-commons.md
small changes for traceability docs
1 parent 86b4716 commit e8f4e31

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

content/en/docs/marketplace/genai/reference-guide/genai-commons.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,13 @@ Lastly, the [Conversational UI module](/appstore/modules/genai/conversational-ui
4949

5050
### Traceability {#traceability}
5151

52-
The chat completions operations of GenAI Commons store data for traceability reasons in your application's database by default. This can be used to understand the usage of GenAI in your app and why the model behaved in certain ways, for example by reviewing the usage of tools. Trace data is only persisted if the constant `StoreTraces` is set to `true`. As traces may contain sensitive and personally-identifiable information, it should be decided per use case if storing such data is compliant.
52+
The chat completions operations of GenAI Commons store data for traceability reasons in your application's database by default. This helps to understand the usage of GenAI in your app and why the model behaved in certain ways, for example by reviewing the usage of tools. Trace data is only persisted if the constant `StoreTraces` is set to `true`.
53+
54+
As traces may contain sensitive and personally-identifiable information, it should be decided per use case whether it is compliant to store such data.
5355

5456
To clean up traces data in a deployed app, you can enable the daily scheduled event `ScE_Trace_Cleanup` in the Mendix Cloud Portal. Use the `Trace_CleanUpAfterDays` constant to control for how long trace data should be persisted.
5557

56-
There are currently no out of the box UI snippets or building blocks available. In a future release those will be covered. To enable read-access to a user (typically an admin user), the module role `TraceMonitoring` needs to be granted to the applicable project roles.
58+
There are currently no out of the box UI snippets or building blocks available. In a future release those will be covered. For now, you can just add a data grid to a page of your choice to display them. To enable read-access to a user (typically an admin user), the module role `TraceMonitoring` needs to be granted to the applicable project roles.
5759

5860
## Technical Reference {#technical-reference}
5961

@@ -153,7 +155,7 @@ A span is created for each interaction between Mendix and the LLM (chat completi
153155

154156
#### `ModelSpan` {#model-span}
155157

156-
A model span is created for each interaction between Mendix and the LLM where content is generated (sent as the assistant's message). In addition to the [Span's](#span) attributes, it also contains the following:
158+
A model span is created for each interaction between Mendix and the LLM where content is generated (sent as the assistant's message). Typically, this is requests for text generation. In addition to the [Span's](#span) attributes, it also contains the following:
157159

158160
| Attribute | Description |
159161
| --- | --- |
@@ -163,7 +165,7 @@ A model span is created for each interaction between Mendix and the LLM where co
163165

164166
#### `ToolSpan` {#tool-span}
165167

166-
A tool span is created for each tool call that the LLM requested. The tool call is processed in GenAI Commons and the result is sent back to the model. In addition to the [Span's](#span) attributes, it also contains the following:
168+
A tool span is created for each tool call requested by the LLM. The tool call is processed in GenAI Commons and the result is sent back to the model. In addition to the [Span's](#span) attributes, it also contains the following:
167169

168170
| Attribute | Description |
169171
| --- | --- |
@@ -174,7 +176,7 @@ A tool span is created for each tool call that the LLM requested. The tool call
174176

175177
#### `KnowledgeBaseSpan` {#knowledge-base-span}
176178

177-
A knowledge base span is created for each knowledge base retrieval tool call that the LLM requested. The tool call is processed in GenAI Commons and the result is sent back to the model. It does not contain any additional attributes compared to [ToolSpan](#tool-span)
179+
A knowledge base span is created for each knowledge base retrieval tool call requested by the LLM. The tool call is processed in GenAI Commons and the result is sent back to the model. It does not contain any additional attributes compared to [ToolSpan](#tool-span)
178180

179181
| Attribute | Description |
180182
| --- | --- |

0 commit comments

Comments
 (0)