Documentation Index
Fetch the complete documentation index at: https://domoinc-arun-raj-connectors-domo-480626-update-new-field-mi.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
はじめに
Jupyterワークスペースを使用すると、メモ内にAIプロンプトを記述できます。Jupyterは、Jupyterから移動せずにDomo. AIプレイグラウンドの場合と同じプロンプトを使用します。
Jupyter AIの詳細については こちら 、AIプレイグラウンドの詳細については こちら を参照してください。
必要な許可
Jupyterにアクセスするには、以下のいずれかの許可が有効になっている権限が必要です。
- Jupyterワークスペースを作成 — ユーザーは、自分がアクセス権を持つJupyterワークスペースを作成、編集、削除できます。
- Jupyterワークスペースを管理 （Jupyter管理者） — ユーザーは、インスタンス内のすべてのJupyterワークスペースを表示、編集、削除できます。ほかのユーザーとワークスペースを共有するには、この許可が必要です。
Jupyterワークスペースにアクセスする
ナビゲーションヘッダーで ［データ］ を選択してData Centerを開きます。
左側のナビゲーションで、 
［More］ （水平の三点リーダー）> ［Jupyterワークスペース］ を選択します。
ワークスペースの作成の詳細については、 こちら を参照してください。
テキスト生成プロンプトを使用する
generate_textプロンプトは、質問に対する回答を提供します。この例では、AIサービスに提供されるプロンプトはprompt_templateにあります。ここには$の制限があり、この値はprompt_parametersに含まれています。
出力プロンプトは下部に指定されます。
input_strに新しいプロンプトを指定することで、標準のgenerate_textテンプレートを変更できます。prompt_templateはinput_strよりも優先されます。
input_strを使用するには、prompt_templateおよびprompt_parametersを削除する必要があります。
generate_text関数では、以下のパラメータを使用できます。 input_str を除くすべてのパラメータはオプションです。
def generate_text(input_str:str,
prompt_template: Optional[PromptTemplate] = None,
parameters: Optional[dict[str, str]] = None,
model: Optional[str] = None,
model_configuration: Optional[dict[str, object]] = None,
system: Optional[str] = None):
"""
文字列入力からテキストを生成
パラメータ:
input_str (str): 入力文字列
prompt_template (PromptTemplate): プロンプトテンプレート
parameters (dict[str, str]): パラメータ
model (str): モデル名
model_configuration (dict[str, object]): モデル設定
system (str): モデルへのプロンプトに含まれるデフォルトのシステム命令のオプションオーバーライド。
戻り値:
response: 生成されたテキスト
"""
text_generation_request = TextGenerationRequest(input_str, prompt_template, parameters, model,
model_configuration, system)
text_response = _jupyterhub.generate_text(text_generation_request.to_json())
text_ai_response = TextAIResponse(text_response['prompt'], text_response['choices'])
return text_ai_response
Text-to-SQLプロンプトを使用する
text_to_sqlプロンプトは質問にもとづいてSQLクエリを提供します。この例では、AIサービスに提供されるプロンプトはprompt_templateに、指定した列はprompt_parametersにあります。
関数SQLクエリは下部の出力で指定されます。
標準のtext_to_sqlテンプレートを変更するには、新しいDataSourceSchemaと、AIプロンプトの記述内容を指定するinput_strを指定します。
ワークスペースに接続されている既存のDataSetにworkspace_data_source_aliasを指定することもできます。workspace_data_source_aliasを指定すると、ワークスペースはSQLクエリの列名を生成するときにスキーマを使用できます。
text_to_sql関数では、以下のパラメータを使用できます。 input_str を除くすべてのパラメータはオプションです。
def text_to_sql(input_str: str,
prompt_template: Optional[PromptTemplate] = None,
data_source_schemas: Optional[list[DataSourceSchema]] = None,
parameters: Optional[dict[str, str]] = None,
model: Optional[str] = None,
model_configuration: Optional[dict[str, object]] = None,
workspace_data_source_alias: Optional[str] = None,
dataframe: Optional[pd.DataFrame] = None,
system: Optional[str] = None
):
"""
テキストをSQLに変換
パラメータ:
input_str (str): 入力文字列
data_source_schemas (list[DataSourceSchema]): データソーススキーマのリスト
prompt_template (PromptTemplate): プロンプトテンプレート
parameters (dict[str, str]): パラメータ
model (str): モデル名
model_configuration (dict[str, object]): モデル設定
workspace_data_source_alias (str): ワークスペースに関連付けられたデータソーススキーマのエイリアス
dataframe (pd.DataFrame): Pandasデータフレーム
system (str): モデルへのプロンプトに含まれるデフォルトのシステム命令のオプションオーバーライド。
戻り値:
text_ai_response: TextAiResponse
""" if workspace_data_source_alias is not None:
data_source_schemas = [
DataSourceSchema.from_optional_list(domojupyter.io.get_schema_from_datasource(workspace_data_source_alias).get('schema'),
workspace_data_source_alias)]
elif dataframe is not None:
schema = domojupyter.io.get_schema_from_dataframe(dataframe)
data_source_schemas = [
DataSourceSchema.from_optional_list(schema,
dataframe.name)]
text_to_sql_request = TextToSQLRequest(input_str, data_source_schemas, prompt_template, parameters, model,
model_configuration, system)
sql_response = _jupyterhub.text_to_sql(text_to_sql_request.to_json())
text_ai_response = TextAIResponse(sql_response['prompt'], sql_response['choices'])
return text_ai_response
テキストからBeast Modeプロンプトを使用する
テキストからBeast Modeサービスは、質問にもとづいてBeast Mode関数を提供します。この例では、AIに提供されるプロンプトで、すべての値の列（data_source_schemas）をまとめて追加するように要求されています。
Beast Mode関数は下部の出力で指定されます。
text_to_beast_mode関数では、以下のパラメータを使用できます。 input_str を除くすべてのパラメータはオプションです。
def text_to_beast_mode(input_str: str,
prompt_template: Optional[PromptTemplate] = None,
data_source_schema: Optional[DataSourceSchema] = None,
parameters: Optional[dict[str, str]] = None,
model: Optional[str] = None,
model_configuration: Optional[dict[str, object]] = None,
system: Optional[str] = None):
"""
テキストをBeastmodeに変換
パラメータ:
input_str (str): 入力文字列
data_source_schema (DataSourceSchema): データソーススキーマ
prompt_template (PromptTemplate): プロンプト
parameters (dict[str, str]): パラメータ
model (str): モデル名
model_configuration (dict[str, object]): モデル設定
system (str): モデルへのプロンプトに含まれるデフォルトのシステム命令のオプションオーバーライド。
戻り値:
sql: SQL文字列
"""
テキスト要約プロンプトを使用する
summarize_textプロンプトは質問にもとづいてテキスト要約を提供します。この例では、AIサービスに提供されるプロンプトはtext_summarizationにあります。
出力プロンプトは下部に表示されます。
summarize_text関数では、以下のパラメータを使用できます。 input_str を除くすべてのパラメータはオプションです。
def summarize(input_str: str,
prompt_template: Optional[PromptTemplate] = None,
parameters: Optional[dict[str, str]] = None,
model: Optional[str] = None,
model_configuration: Optional[dict[str, object]] = None,
system: Optional[str] = None,
chunking_configuration: Optional[ChunkingConfiguration] = None,
output_style: Optional[SummarizationOutputStyle] = None,
output_word_length: Optional[SizeBoundary] = None):
"""
テキスト要約
パラメータ:
input_str (str): 要約対象のテキスト情報。この属性は必須です。
prompt_template (PromptTemplate): プロンプトテンプレート
parameters (dict): パラメータ名とそれに対応する値を含む辞書。
PromptTemplate内のプレースホルダを置き換えるために使用します。
model (str): 要約に使用する言語モデルの名前/id
model_configuration (dict): 選択した言語モデルのカスタム構成パラメータを持つ辞書。
system (str): モデルへのプロンプトに含まれるデフォルトのシステム命令のオプションオーバーライド。
chunking_configuration (ChunkingConfiguration): 指定されたテキストをより小さいパーツまたはチャンクに分割するための設定。
output_style (SummarizationOutputStyle): 要約の出力のデザイン、構造化、および構成を決定。
output_word_length (SizeBoundary): ワード数にもとづいて出力要約の長さを制限するサイズ境界を定義。
戻り値:
response: 要約されたテキスト
"""
