AI 関数

AI 関数は ClickHouse の組み込み関数で、AI の呼び出しや埋め込みの生成に使用でき、データの処理、情報の抽出、データの分類などを行えます。

すべての関数は、以下を提供する共通のインフラストラクチャを利用しています。

• クォータの適用: トークン (ai_function_max_input_tokens_per_query, ai_function_max_output_tokens_per_query) および API 呼び出し (ai_function_max_api_calls_per_query) に対するクエリ単位の上限。
• バックオフ付き再試行: 一時的な障害は、指数バックオフ (ai_function_retry_initial_delay_ms) を使用して再試行 (ai_function_max_retries) されます。

AI 関数は、プロバイダーの認証情報と設定を格納した 名前付きコレクション を参照します。関数ごと、または関数呼び出しごとに、異なる 名前付きコレクション を作成して使い分けることができます。たとえば、テキスト関数 (aiGenerate、aiClassify、aiFilter、aiExtract、aiTranslate、aiRedact) で使用する 名前付きコレクション と、異なるエンドポイントが必要で通常は異なるモデルを使用する埋め込み関数 (aiEmbed、aiSimilarity) で使用する 名前付きコレクション を、別々に定義したい場合があります。

プロバイダーの認証情報を含む 名前付きコレクション を作成するための例のステートメントを以下に示します。1 つはチャット用エンドポイント、もう 1 つは埋め込み用エンドポイントです。

CREATE NAMED COLLECTION ai_text_credentials AS
    provider = 'openai',
    endpoint = 'https://api.openai.com/v1/chat/completions',
    model = 'gpt-4o-mini',
    api_key = 'sk-...';

-- The embedding functions (`aiEmbed`, `aiSimilarity`) do not read `model` from the named collection,
-- pass it as a positional argument instead. Defining `model` in an embedding collection is an error,
-- not silently ignored.
CREATE NAMED COLLECTION ai_embedding_credentials AS
    provider = 'openai',
    endpoint = 'https://api.openai.com/v1/embeddings',
    api_key = 'sk-...';

関数は、使用する 名前付きコレクション を次の順序で特定します。

1. 存在する場合は、パラメータマップの credentials キー。
2. それ以外の場合は、該当するデフォルト認証情報の設定。
   • テキスト関数 (aiGenerate、aiClassify、aiFilter、aiExtract、aiTranslate、aiRedact) では ai_function_text_default_credentials。
   • 埋め込み関数 (aiEmbed、aiSimilarity) では ai_function_embedding_default_credentials。

どちらも設定されていない場合、呼び出しは失敗します。テキスト関数と埋め込み関数でデフォルト設定が分かれているのは、chat-completions のエンドポイントが embeddings 用のものとは異なるためです。

SET ai_function_text_default_credentials = 'ai_text_credentials';

-- Uses ai_text_credentials from the setting:
SELECT aiGenerate('What is 2 + 2? Reply with just the number.');

-- Overrides the default for this call:
SELECT aiGenerate('Bonjour', map('credentials', 'other_credentials'));

UInt8 を返し、WHERE 句で直接使用できる aiFilter を使って、自然言語の条件で行をフィルタリングします。

SELECT * FROM reviews
WHERE aiFilter(body, 'the customer is angry about shipping');

各関数は、末尾に任意の Map(String, String) のパラメータマップを受け取れます。すべての値は文字列です (数値も '0.2' のようにクォートしてください) 。不明なキーは受け付けられません。指定されたキーは、対応する 名前付きコレクション の値を上書きします。指定されていないキーは、名前付きコレクション (model/max_tokens の場合) または組み込みのデフォルト値が使われます。例外は埋め込み関数 (aiEmbed、aiSimilarity) で、model を必須の位置引数として受け取り (例: aiEmbed(text, model[, params])、aiSimilarity(text1, text2, model[, params]))、代わりにパラメータマップや 名前付きコレクション に設定するとエラーになります。これは再現可能な埋め込みを保証するためです。

以下のパラメータは、すべての AI 関数に共通です。

各関数は、これに加えて関数固有の追加パラメータ (max_tokens、temperature、system_prompt、instructions、dimensions など) を受け付けます。受け付けるパラメータとそのデフォルト値については、以下の各関数のリファレンスを参照してください。

SELECT aiGenerate(body, map('temperature', '0.2', 'system_prompt', 'You are terse.')) FROM articles;

すべての AI 関連の設定は、ai_function_ プレフィックスで Settings に一覧表示されています。

AI 名前付きコレクション の endpoint URL は、サーバーが自身の identity で接続する送信先であり、リクエストヘッダーに 名前付きコレクション の api_key を (指定されている場合に) 含めて送信する可能性があります。デフォルトでは、ClickHouse はすべてのホストへの接続を許可します。関数を特定の provider 群のみに制限するには、サーバー設定で remote_url_allow_hosts を設定します。例:

<remote_url_allow_hosts>
    <host>api.openai.com</host>
    <host>api.anthropic.com</host>
</remote_url_allow_hosts>

この設定はサーバー全体に適用され、HTTP を使用するすべての機能に適用されることに注意してください。

転送方式は、endpoint URL のスキームのみによって決まります。リクエストのペイロード自体がアプリケーションレベルで暗号化されることはなく、転送中データの保護はスキームに完全に依存します。

• https:// — 接続に TLS が使用されます。リクエストボディ (入力テキスト、プロンプト) と、リクエストヘッダー内の api_key は転送中に暗号化され、プロバイダー の certificate も検証されます。リモートの プロバイダー には必ずこちらを使用してください。
• http:// — 接続は暗号化されません。リクエストボディと api_key は平文で送信されます。これは、private network 上の信頼できる プロバイダー (例: ローカルの vLLM または Ollama インスタンス) に対してのみ使用してください。

デフォルトでは、AI 関数はリモート host に平文でデータを送信する endpoint を拒否します。host がループバックでない HTTPS 以外のエンドポイント は例外を発生させます。ループバック host (localhost、127.0.0.0/8、::1) は対象外のため、ローカルの http://localhost モデル server はそのまま動作します。リモート host で平文の http:// エンドポイント を許可するには、ai_function_allow_insecure_endpoint を 1 に設定します。この check は remote_url_allow_hosts とは独立しています。この設定は host の allowlist であり、URL スキームは検査しないため、許可された host を指す http:// エンドポイント は引き続き許可されます。

いずれの場合も、プロバイダー は TLS 終端後の入力データを平文で受け取る点に注意してください。TLS が保護するのは、server と プロバイダー の間のネットワーク経路上のデータのみです。

AI 関数のアクティビティは、ClickHouse の ProfileEvents で追跡できます。

これらのイベントをクエリします。

SELECT
    ProfileEvents['AIAPICalls'] AS api_calls,
    ProfileEvents['AIInputTokens'] AS input_tokens,
    ProfileEvents['AIOutputTokens'] AS output_tokens
FROM system.query_log
WHERE query_id = 'query_id'
AND type = 'QueryFinish'
ORDER BY event_time DESC;

導入バージョン: v26.4.0

指定されたテキストを、LLMプロバイダーを使用して、与えられたカテゴリのいずれか 1 つに分類します。

認証情報 (プロバイダー、モデル、エンドポイント、および必要に応じて API key を指定する 名前付きコレクション) は、オプションの パラメータマップ の credentials キーから取得されるか、その map で省略されている場合は ai_function_text_default_credentials 設定から取得されます。

構文

aiClassify(text, categories[, params])

別名: AIClassify

引数

• text — 分類するテキスト。String
• categories — 候補となるカテゴリラベルの定数リスト。Array(String)
• params — オプションの定数 Map(String, String) パラメータ。関数固有のキー: temperature (ランダム性を制御するサンプリング温度。デフォルト 0.0)、max_tokens (1 回の呼び出しあたりの最大出力トークン数。デフォルト 1024)。共通パラメータ credentials と model も適用されます (AI 関数 を参照)。Map(String, String)

戻り値

指定されたカテゴリラベルのいずれか、またはリクエストが失敗し、ai_function_throw_on_error が無効になっている場合はカラム型のデフォルト値 (空文字列) 。String

例

感情を分類

SET allow_experimental_ai_functions = 1;
SELECT aiClassify('I love this product!', ['positive', 'negative', 'neutral'])

positive

明示的に指定した認証情報を使用してカラムを分類する

SET allow_experimental_ai_functions = 1;
CREATE TABLE issues (body String) ENGINE = Memory;
INSERT INTO issues VALUES ('The application exits unexpectedly after login.');
SELECT body, aiClassify(body, ['bug', 'question', 'feature'], map('credentials', 'ai_text_credentials')) AS kind FROM issues LIMIT 5

導入バージョン: v26.6.0

設定済みの AI プロバイダー を使用して、指定されたテキストの埋め込みベクトルを生成します。

この関数はテキストを設定済みの埋め込み用エンドポイントに送信し、生成されたベクトルを Array(Float32) として返します。 1つの block 内の行については、呼び出しごとのオーバーヘッドを減らすため、入力は 1回の HTTP リクエスト あたり最大 ai_function_embedding_max_batch_size エントリの batches にグループ化されます。

認証情報 (プロバイダー、エンドポイント、必要に応じて API key を指定する 名前付きコレクション) は、パラメータマップ の credentials キーから取得されるか、 map で省略されている場合は ai_function_embedding_default_credentials 設定から取得されます。aiEmbed では テキスト関数とは別のデフォルト認証情報設定が使われる点に注意してください。これは、埋め込み用エンドポイントが chat エンドポイント とは異なるためです。

model は必須の位置引数 (定数の String) です。テキスト関数とは異なり、 aiEmbed は 名前付きコレクション や パラメータマップ から model を読み取りません。model を定義する 名前付きコレクション は、 拒否されます。

オプションの dimensions パラメータ は、モデルが対応している場合 (たとえば OpenAI's text-embedding-3-*) 、 指定したサイズのベクトルを要求します。対応していない場合は、モデル本来のサイズが返されます。

構文

aiEmbed(text, model[, params])

別名: AIEmbed

引数

• text — 埋め込み対象のテキスト。String
• model — 埋め込みモデル名。const String
• params — 省略可能な定数 Map(String, String) パラメータ。関数固有のキー: dimensions (出力ベクトルの目標次元数。0 または省略時はモデルのネイティブのサイズを意味します) 。共通パラメータ credentials も使用できます (AI 関数 を参照) 。Map(String, String)

戻り値

埋め込みベクトル。入力が NULL または空の場合、リクエストが失敗して ai_function_throw_on_error が無効になっている場合、あるいは ai_function_throw_on_quota_exceeded が無効になっている状態でクォータを超過した場合は、空のArrayを返します。Array(Float32)

例

単一の文字列を埋め込む (ai_function_embedding_default_credentials が設定されている場合、credentials は省略できます)

SET allow_experimental_ai_functions = 1;
SELECT aiEmbed('Hello world', 'text-embedding-3-small', map('credentials', 'ai_embedding_credentials'))

次元を明示する場合

SET allow_experimental_ai_functions = 1;
SELECT aiEmbed('Hello world', 'text-embedding-3-small', map('credentials', 'ai_embedding_credentials', 'dimensions', '256'))

テキストのカラムを埋め込む

SET allow_experimental_ai_functions = 1;
CREATE TABLE articles (title String) ENGINE = Memory;
INSERT INTO articles VALUES ('ClickHouse is a fast analytical database.');
SELECT aiEmbed(title, 'text-embedding-3-small', map('credentials', 'ai_embedding_credentials', 'dimensions', '256')) FROM articles LIMIT 10

導入バージョン: v26.4.0

LLMプロバイダーを使用して、非構造化テキストから構造化情報を抽出します。

3 番目の引数には、自由形式の自然言語による指示 (例: '主な訴え') または '{"field_a": "field a の説明", "field_b": "field b の説明"}' の形式の JSON エンコードされたスキーマを指定できます。

指示モードでは、この関数は抽出した値をプレーンな文字列として返し、何も見つからなかった場合は空文字列を返します。 スキーマモードでは、この関数は要求されたスキーマに対応するキーを持つ JSON オブジェクト文字列を返します。存在しないフィールドは null になります。

認証情報 (プロバイダー、モデル、エンドポイント、および必要に応じて API key を指定する 名前付きコレクション) は、省略可能な パラメータマップ の credentials キーから取得されるか、 map で省略されている場合は ai_function_text_default_credentials setting から取得されます。

構文

aiExtract(text, instruction_or_schema[, params])

別名: AIExtract

引数

• text — 情報を抽出するテキスト。String
• instruction_or_schema — 自由形式の抽出指示、または抽出するフィールドを記述した定数の JSONオブジェクト。const String
• params — オプションの定数 Map(String, String) パラメータ。関数固有のキー: temperature (ランダム性を制御するサンプリング温度。デフォルト 0.0)、max_tokens (1 回の呼び出しあたりの最大出力トークン数。デフォルト 1024)。共通パラメータである credentials と model も適用されます (AI 関数 を参照)。Map(String, String)

戻り値

単一の抽出結果 (指示モード) または JSONオブジェクト文字列 (スキーマモード) 。リクエストが失敗し、ai_function_throw_on_error が無効になっている場合は、カラム型のデフォルト値 (空文字列) を返します。String

例

自由形式の指示

SET allow_experimental_ai_functions = 1;
SELECT aiExtract('The package arrived late and was damaged.', 'the main complaint')

late and damaged package

スキーマ抽出

SET allow_experimental_ai_functions = 1;
CREATE TABLE reviews (review String) ENGINE = Memory;
INSERT INTO reviews VALUES ('The screen is bright, but the battery lasts only two hours.');
SELECT aiExtract(review, '{"sentiment": "positive, negative or neutral", "topic": "main topic of the review"}') FROM reviews LIMIT 5

導入バージョン: v26.8.0

LLMプロバイダー を使用して指定されたテキストに対する自然言語の条件を評価し、WHERE、PREWHERE、JOIN ... ON で使用できるブール値 (UInt8) を返します。

この関数は、モデルに小文字の true または false のみで応答するよう求めます。true 以外の完全な応答 (false や認識できないテキストを含む) は 0 にマッピングされるため、行は除外されます。一方、プロバイダーから不完全と通知された応答 (切り詰められた応答、コンテンツフィルタリングされた応答、または追加のアクションが必要な応答) はエラーとして扱われます。ai_function_throw_on_error が有効な場合 (デフォルト) はクエリが中止され、無効な場合は行が 0 にマッピングされて除外されます。

警告: aiFilter の結果を無批判に信用しないでください。LLM ベースの述語は不正確であったり、一貫性を欠いたりする可能性があります。偽陽性や偽陰性が許容される場合にのみ使用してください。

認証情報 (プロバイダー、モデル、エンドポイント、および必要に応じて API key を指定する 名前付きコレクション) は、任意の パラメータマップ の credentials キーから取得されます。このキーが map で省略されている場合は、ai_function_text_default_credentials 設定から取得されます。

注: JOIN ... ON で aiFilter を使用すると、候補ペアごとに LLM が一度評価されるため、コストが高くなる可能性があります。

構文

aiFilter(text, condition[, params])

別名: AIFilter

引数

• text — 評価対象のテキスト。String
• condition — テキストが満たす必要がある、定数の自然言語条件。String
• params — 任意の定数 Map(String, String) 型パラメータ。関数固有のキー: temperature (ランダム性を制御するサンプリング温度、デフォルトは 0.0) 、max_tokens (呼び出しあたりの最大出力トークン数、デフォルトは 1024) 。共通パラメータの credentials と model も適用されます (AI 関数を参照) 。Map(String, String)

戻り値

テキストが条件に一致する場合は 1、それ以外の場合は 0。リクエストが失敗し、ai_function_throw_on_error が無効の場合は、デフォルト値 (0) を返します。UInt8

例

怒りを含むレビューをフィルタリングする

SET allow_experimental_ai_functions = 1;
CREATE TABLE reviews (body String) ENGINE = Memory;
INSERT INTO reviews VALUES ('The package arrived three days late.');
SELECT * FROM reviews WHERE aiFilter(body, 'the customer is angry about shipping')

認証情報を明示的に指定してカラムをフィルタリングする

SET allow_experimental_ai_functions = 1;
CREATE TABLE issues (body String) ENGINE = Memory;
INSERT INTO issues VALUES ('The application exits unexpectedly after login.');
SELECT body, aiFilter(body, 'describes a bug', map('credentials', 'ai_text_credentials')) AS is_bug FROM issues LIMIT 5

導入バージョン: v26.4.0

LLMプロバイダーを使用して、プロンプトから自由形式のテキストコンテンツを生成します。

この関数は、プロンプトを設定済みのAIプロバイダーに送信し、生成されたテキストを返します。

認証情報 (プロバイダー、モデル、endpoint、および必要に応じて API key を指定する名前付きコレクション) は、任意のパラメータマップの credentials キーから取得されるか、 パラメータマップで省略されている場合は ai_function_text_default_credentials 設定から取得されます。

任意のパラメータマップでは、system_prompt (モデルの 動作 (例: tone、format、role) を導く指示) 、temperature、max_tokens、model も設定できます。system_prompt が 設定されていない場合のデフォルト値は次のとおりです: You are a helpful assistant. Provide a clear and concise response.

構文

aiGenerate(prompt[, params])

別名: AIGenerate

引数

• prompt — モデルに送信する、ユーザーのプロンプトまたは質問。String
• params — 省略可能な定数 Map(String, String) パラメータ。関数固有のキーは次のとおりです: temperature (ランダム性を制御するサンプリング温度。デフォルトは 0.7) 、max_tokens (1 回の呼び出しで生成できる最大トークン数。デフォルトは 1024) 、system_prompt (モデルの振る舞いを導く定数のシステムレベル命令。デフォルトは汎用的なアシスタント用プロンプト) 。共通パラメータの credentials と model も利用できます (AI 関数 を参照) 。Map(String, String)

戻り値

生成されたテキスト応答。リクエストが失敗し、ai_function_throw_on_error が無効になっている場合は、カラム型のデフォルト値 (空文字列) が返されます。String

例

単純な質問

SET allow_experimental_ai_functions = 1;
SELECT aiGenerate('What is 2 + 2? Reply with just the number.')

4

明示的に指定した認証情報とシステムプロンプト

SET allow_experimental_ai_functions = 1;
SELECT aiGenerate('Explain ClickHouse', map('credentials', 'ai_text_credentials', 'system_prompt', 'You are a database expert. Be concise.'))

カラムの値を要約する

SET allow_experimental_ai_functions = 1;
CREATE TABLE articles (article_title String, article_body String) ENGINE = Memory;
INSERT INTO articles VALUES ('ClickHouse', 'ClickHouse is an open-source column-oriented database for online analytical processing.');
SELECT article_title, aiGenerate(concat('Summarize in one sentence: ', article_body)) AS summary FROM articles LIMIT 5

導入バージョン: v26.8.0

LLMプロバイダーを使用して、指定されたテキスト内の個人を特定できる情報 (PII) を検出し、マスキングします。

検出された各 PII span は、マスキングトークン (デフォルトでは [REDACTED]、replacement parameter で設定可能) に置き換えられます。categories Array は、マスキングする PII の種類を制限します。空のArrayを指定した場合は、 一般的なカテゴリ (名前、メールアドレス、電話番号、住所、クレジットカード、IP アドレス) からなるデフォルトのセットにフォールバックします。

aiRedact は、検出された PII span のみを変更するようモデルに指示しますが、周囲のテキストの保持は ベストエフォートであり、モデルが変更する可能性があります (上記の警告を参照) 。タブ、 改行、復帰以外の制御文字もリクエスト前にスペースへ正規化されるため、これらを含む入力では出力が バイト単位で同一にはなりません。

aiRedact は PII を置き換えた入力テキスト全体を返すため、出力は入力とほぼ同じ長さになります。 max_tokens (デフォルトは 1024) を、トークン単位の入力長より大きく設定してください。上限が低すぎて切り詰められた応答は、 部分的にマスキングされたテキストを返すのではなく、AI_PROVIDER_RESPONSE_TRUNCATED により拒否されます (ai_function_throw_on_error が無効な場合はカラムのデフォルト値を返します) 。

構文

aiRedact(text, categories[, params])

別名: AIRedact

引数

• text — マスキング対象のテキスト。String
• categories — マスキングする PII カテゴリの定数リスト (例: ['name', 'ssn', 'credit_card']) 。空のArrayを指定すると、一般的なカテゴリ (名前、メールアドレス、電話番号、住所、クレジットカード、IP アドレス) のデフォルトセットが使用されます。Array(String)
• params — 任意の定数 Map(String, String) パラメータ。関数固有のキー: temperature (ランダム性を制御するサンプリング温度、デフォルト 0.0) 、max_tokens (呼び出しごとの最大出力トークン数、デフォルト 1024 — aiRedact はテキスト全体を返すため、入力のトークン数より大きい値に設定してください。上限が低すぎて切り詰められた応答は、部分的にマスキングされたテキストを返すのではなく拒否されます) 、replacement (検出された各 PII span を置き換えるトークン、デフォルト [REDACTED]) 。共通パラメータの credentials と model も適用されます (AI 関数を参照) 。Map(String, String)

戻り値

検出された PII をマスキングトークンで置き換えたテキスト。リクエストが失敗し、ai_function_throw_on_error が無効の場合は、カラム型のデフォルト値 (空文字列) 。String

例

特定のカテゴリをマスキングする

SET allow_experimental_ai_functions = 1;
SELECT aiRedact('Purchase was done by customer John Doe with email test@test.org', ['email', 'credit_card', 'name'])

Purchase was done by customer [REDACTED] with email [REDACTED]

カスタムトークンを使用してデフォルトのPIIカテゴリをマスキングする

SET allow_experimental_ai_functions = 1;
CREATE TABLE tickets (body String) ENGINE = Memory;
INSERT INTO tickets VALUES ('Contact Jane Doe at jane@example.com.');
SELECT aiRedact(body, [], map('replacement', '***')) FROM tickets LIMIT 5

導入バージョン: v26.8.0

設定された埋め込みプロバイダーを使用して、2つのテキスト間の意味的な類似度を計算します。

両方のテキストのベクトル埋め込みを計算し、それらの コサイン類似度を返します。-1 のスコアは 反対方向の埋め込みベクトルに与えられ、意味的には、スコアが -1 に近いテキストは意味が反対であることを示します。 0 のスコアはベクトルが直交している、つまり意味的に無関係であることを示します。最後に、1 のスコアは 埋め込みベクトルが同じ方向を向いていることを意味し、スコアが 1 に近いテキストは 意味が類似しています。これは、同じ埋め込みに対する cosineDistance の補数です (aiSimilarity = 1 - cosineDistance(embedding1, embedding2)) 。

バッチ処理、認証情報、dimensions パラメータは aiEmbed と同じであり、 ai_function_embedding_default_credentials のデフォルト認証情報設定も含まれます。

aiEmbed と同様に、model は必須の位置引数 (定数の String) であり、名前付きコレクションや パラメータマップからは読み取られません。

構文

aiSimilarity(text1, text2, model[, params])

別名: AISimilarity

引数

• text1 — 1つ目のテキスト。String
• text2 — 2つ目のテキスト。String
• model — 埋め込みモデル名。const String
• params — 任意の定数 Map(String, String) 型パラメータ。関数固有のキー: dimensions (埋め込みの目標次元数。0 または省略した場合はモデル本来の次元数) 。共通パラメータ credentials も適用されます (AI 関数を参照) 。Map(String, String)

戻り値

[-1, 1] のコサイン類似度。いずれかのテキストが NULL または空の場合、埋め込みリクエストが失敗し ai_function_throw_on_error が無効な場合、または ai_function_throw_on_quota_exceeded が無効な状態でクォータを超過した場合は NULL。Nullable(Float32)

例

2つの文字列を比較 (ai_function_embedding_default_credentials 設定が指定されている場合、credentials は省略できます)

SET allow_experimental_ai_functions = 1;
SELECT aiSimilarity('cat', 'kitten', 'text-embedding-3-small', map('credentials', 'ai_embedding_credentials'))

クエリとの類似度に基づいてレビューをランク付けする

SET allow_experimental_ai_functions = 1;
CREATE TABLE product_reviews (review String) ENGINE = Memory;
INSERT INTO product_reviews VALUES ('It works well under rain.');
SELECT review FROM product_reviews ORDER BY aiSimilarity(review, 'It works well under rain', 'text-embedding-3-small') DESC LIMIT 100

自己結合による意味的重複排除

SET allow_experimental_ai_functions = 1;
CREATE TABLE docs (id UInt64, title String) ENGINE = Memory;
INSERT INTO docs VALUES (1, 'ClickHouse documentation'), (2, 'ClickHouse database guide');
SELECT a.id, b.id FROM docs a, docs b WHERE a.id < b.id AND aiSimilarity(a.title, b.title, 'text-embedding-3-small') > 0.9

導入バージョン: v26.4.0

指定されたテキストを、LLMプロバイダーを使用して指定した対象言語に翻訳します。

文体や方言に関する追加の指示は、パラメータマップの instructions キーで渡すことができます (例: '技術用語は翻訳しない') 。

認証情報 (プロバイダー、モデル、endpoint、および必要に応じて API key を指定する 名前付きコレクション) は、省略可能なパラメータマップの credentials キーから取得され、マップでこれが省略されている場合は ai_function_text_default_credentials 設定から取得されます。

構文

aiTranslate(text, target_language[, params])

別名: AITranslate

引数

• text — 翻訳するテキスト。 String
• target_language — 対象言語名または BCP-47 コード (例: 'French', 'es-MX') 。 String
• params — 省略可能な定数 Map(String, String) パラメータ。関数固有のキー: temperature (ランダム性を制御するサンプリング温度。デフォルトは 0.3) 、max_tokens (1 回の呼び出しで生成される出力トークンの最大数。デフォルトは 1024) 、instructions (翻訳向けの追加のスタイルまたは方言に関する指示) 。共通パラメータの credentials と model も使用できます (AI 関数 を参照) 。 Map(String, String)

戻り値

翻訳されたテキスト。リクエストが失敗し、ai_function_throw_on_error が無効な場合は、カラム型のデフォルト値 (空文字列) を返します。 String

例

フランス語に翻訳

SET allow_experimental_ai_functions = 1;
SELECT aiTranslate('Hello, world!', 'French')

Bonjour le monde!

スタイル指示に従って日本語に翻訳

SET allow_experimental_ai_functions = 1;
CREATE TABLE articles (body String) ENGINE = Memory;
INSERT INTO articles VALUES ('ClickHouse processes analytical queries quickly.');
SELECT aiTranslate(body, 'Japanese', map('instructions', 'Use polite form (desu/masu)')) FROM articles LIMIT 5