[Feat] get vizro ai customized text output

[Anna-Xiong]

Description

we will have a dataclass for Plot components.

@dataclass
class Plot:
    """Data class about a vizro ai plot."""

    code_string: str
    fig: go.Figure = field(default=None)
    business_insights: str = field(default=None)
    code_explanation: str = field(default=None)

here is our updated plot() call.

    def plot(
        self,
        df: pd.DataFrame,
        user_input: str,
        explain: bool = False,
        max_debug_retry: int = 3,
        return_plot_components: bool = False,
    ) -> Union[go.Figure, Plot]:

• explain controls whether to run extra LLM to get text insights of business and code explanation
• return_plot_components controls whether to Plot dataclass or return only plotly fig object

Pending:

• Integration test needs to be updated, another PR will address integration tests and

 # TODO Tentative for integration test, will be updated/removed for new tests
        if self._return_all_text:
            return output_dict

will be deleted afterwards.

• I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

  • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
  • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
  • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
  • I have not referenced individuals, products or companies in any commits, directly or indirectly.
  • I have not added data or restricted code in any commits, directly or indirectly.

[maxschulz-COL]

I like it! I think this should have the exact same API as the plot function, and it does!

A couple of ideas for suggestions:

• maybe tune the name so we know the return type: get_plot_dict?
• Warning is nice, but I think not even necessary, could even skip it

Other than that, think this is great 💪 let's do it

Will do a final review once you finalised it, thanks!

[antonymilne]

Just a final suggestion on the names: return_elements is ok but I think I'd prefer return_full overall if that makes sense for you two also? @maxschulz-COL @Anna-Xiong

[Anna-Xiong]

Just a final suggestion on the names: return_elements is ok but I think I'd prefer return_full overall if that makes sense for you two also? @maxschulz-COL @Anna-Xiong

I am ok either way, but slightly towards return_elements or return_full_elements? Let's see what @maxschulz-COL thinks?

[maxschulz-COL]

Just a final suggestion on the names: return_elements is ok but I think I'd prefer return_full overall if that makes sense for you two also? @maxschulz-COL @Anna-Xiong

I am ok either way, but slightly towards return_elements or return_full_elements? Let's see what @maxschulz-COL thinks?

I prefer return_elements - I find that is really what it is.

[antonymilne]

Fine by me, let's go for return_elements then 🙂