API
generate_report

generate_report

generate_report 関数


概要:

generate_report 関数は、MorphプラットフォームのPythonセルから可視化されたデータを集めて、集約されたレポートを生成します。この関数は、特に可視化デコレータ @visualize が適用されたセルの結果を要求し、それらを統合して一つのレポートを作成します。

パラメータ:

  • refs (list[RefResponse]): 参照するPythonセルのリスト。各セルは可視化が含まれている必要があります。
  • prompt (Optional[str]): レポートの生成に使用する追加のプロンプトまたは説明。
  • language (Optional[str]): レポート作成に使用する言語。

戻り値:

  • str: 生成されたレポートの内容。Markdown形式で提供されます。

使用例:

from typing import Dict
import pandas as pd
import plotly.express as px
from morphdb_utils.annotations import report
from morphdb_utils.api import ref, generate_report
 
# The `data` is not used for reporting, but needs to be declared to execute the main function.
data = {}
 
@report
def main(data: Dict[str, pd.DataFrame]):
    return generate_report(
        refs=[
            ref("python_60096"),
        ],
        prompt="write reports for sales meeting in details according to the data",  # please fill in the prompt for the report
        language="English"
    )

この関数は特にデータ分析やビジュアライゼーションが多用される状況下で有効に機能します。複数のビジュアライゼーションを組み合わせた包括的なレポートを自動的に生成することができます。

generate