Explain Object with AI

Get an AI-driven explanation of an object’s code directly in the source code viewer

Overview

This option provides an AI-driven explanation of the code in the object.

How does it work?

  1. User triggers to explain object: the user initiates explanation generation from the user interface.
  2. System shares the code snippet for object with LLM: the system shares:
    • Source code snippet for the object.
  3. LLM reads code and generates an object-level explanation: use the LLM to fetch an explanation for the source code shared in simple natural language
  4. Display explanation for the user

Key points:

  • The source code for object involved is shared to the LLM.
  • Explanation can be generated as a summary or detailed explanation can be generated
  • Save it as post it for documentation reference.

What does it do?

Enables right-click contextual menu options when consulting results at Object level:

The “Explain the object” option provides an AI-driven explanation of the code in the object, directly in the source code viewer:

AI will also point out issues that it believes may exist in your source code:

Finally, two options are made available when the AI explanation has been provided:

  • Save the explanation as a Post-It assigned to the object in question
  • Re-load the explanation and provided additional details