ai_generate_text function | Databricks on AWS [2023/4/18時点]の翻訳です。
本書は抄訳であり内容の正確性を保証するものではありません。正確な内容に関しては原文を参照ください。
プレビュー
本機能はパブリックプレビューです。
プロンプトを指定することで、選択した大規模言語モデル(LLM)によって生成されたテキストを返却します。
要件
- この関数はDatabricks SQL Proとサーバレスでのみ利用可能です。
- この機能はパブリックプレビューです。パブリックプレビューに参加するには、AI Functions Public Preview enrollment formを提出してください。
構文
ai_generate_text(prompt, modelName[, param1, value1] [...])
引数
-
prompt: 文字列、選択したLLMに渡すテキストプロンプトです。 -
modelName: 文字列リテラル、openai/gpt-3.5-turboとazure_openai/gpt-35-turboのみがサポートされています。 -
paramNとvalueN: 選択したLLMを認証、設定するためのキーバリューペア。キーは文字列リテラルで大文字小文字を区別します。バリューのタイプは以下のキーに依存します:- モデル
openai/gpt-3.5-turboは、Open AIのチャットコンプリーションAPIを使用します。以下のパラメーターをサポートします:-
apiKey: 必須。モデルエンドポイントにアクセスするためのOpenAI APIキーです。値を指定するにはシークレット機能を使用しなくてはなりません。 -
temperature: 使用するサンプリングテンプルチュア。0から2の間の数値リテラルです。デフォルトは1.0です。 -
stop: ストップ文字列。値はSTRINGリテラル、あるいは最大4つの文字列リテラルのARRAY<STRING>となります。デフォルトはnullです。
-
- モデル
azure_openai/gpt-35-turboはAzure OpenAIサービスのチャットコンプリーションAPIを使用します。上述のopenai/gpt-3.5-turboモデルの全てのパラメーターと、エンドポイントURLを構成する任意の追加パラメーターを受け付けます。DatabricksではAPIキー認証のみをサポートしています。-
resourceName: 必須。リソース名を指定する文字列リテラルです。 -
deploymentName: 必須。デプロイメント名を指定する文字列リテラルです。 -
apiVersion: 必須。使用するAPIバージョンを指定する文字列リテラルです。
-
- モデル
戻り値
選択したLLMから生成されたテキストを表現する文字列表現です。
サンプル
SQL
> SELECT ai_generate_text('Hello', 'openai/gpt-3.5-turbo',
'apiKey', secret('ml', 'key'),
'temperature', 0.1);
Hello! How can I assist you today?
> SELECT ai_generate_text('Hello',
'azure_openai/gpt-35-turbo',
'apiKey', secret('ml', 'key'),
'resouceName', 'resource',
'deploymentName', 'deploy',
'apiVersion', '2023-03-15-preview',
'temperature', 0.1);
Hello! How can I assist you today?
> SELECT ai_generate_text('Hello',
'openai/gpt-3.5-turbo',
'apiKey', 'sg-xxxxxxxxxxxxxxxxxxxxxx',
'temperature', 0.1);
Error: DATATYPE_MISMATCH.INVALID_SECRET
The value expression of API_TOKEN can only be a `secret(<scope>, <key>)` function; however, got StringLiteral sg-xxxxxxxxxxxxxxxxxxxxxx.