Функции ИИ

Функции ИИ — это встроенные функции ClickHouse, которые можно использовать для вызова ИИ или генерации эмбеддингов при работе с данными, извлечении информации, классификации данных и т. д.

Все функции используют общую инфраструктуру, которая обеспечивает:

• Контроль квот: лимиты на количество токенов в рамках одного запроса (ai_function_max_input_tokens_per_query, ai_function_max_output_tokens_per_query) и вызовов API (ai_function_max_api_calls_per_query).
• Повторные попытки с задержкой: при временных сбоях выполняются повторные попытки (ai_function_max_retries) с экспоненциально растущей задержкой (ai_function_retry_initial_delay_ms).

Функции ИИ используют именованную коллекцию, в которой хранятся учётные данные провайдера и параметры конфигурации. Для разных функций или их вызовов можно создавать и использовать разные именованные коллекции. Например, для текстовых функций (aiGenerate, aiClassify, aiFilter, aiExtract, aiTranslate, aiRedact) и функций эмбеддингов (aiEmbed, aiSimilarity) можно определить отдельные именованные коллекции, так как им требуются разные конечные точки и обычно разные модели.

Пример оператора для создания именованной коллекции с учётными данными провайдера: одна — с конечной точкой для чата, другая — с конечной точкой для эмбеддингов:

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. в противном случае — соответствующую настройку учетных данных по умолчанию:
   • ai_function_text_default_credentials для текстовых функций (aiGenerate, aiClassify, aiFilter, aiExtract, aiTranslate, aiRedact);
   • ai_function_embedding_default_credentials для функций эмбеддингов (aiEmbed, aiSimilarity).

Если не задано ни то ни другое, вызов завершится ошибкой. Для текстовых функций и функций эмбеддингов используются разные настройки по умолчанию, поскольку конечная точка для chat-completions отличается от конечной точки для эмбеддингов.

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'));

Фильтруйте строки по условию на естественном языке с помощью aiFilter, которая возвращает UInt8 и может использоваться непосредственно в предложении WHERE:

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])), и если вместо этого задать его в карте параметров или именованной коллекции, возникнет ошибка. Это необходимо для обеспечения воспроизводимости эмбеддингов.

Следующие параметры являются общими для всех функций ИИ:

Отдельные функции принимают дополнительные, специфичные для конкретной функции параметры (например, max_tokens, temperature, system_prompt, instructions и dimensions). Сведения о поддерживаемых параметрах и их значениях по умолчанию см. ниже в справочнике для каждой функции.

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

Все настройки, связанные с ИИ, перечислены в разделе Настройки и имеют префикс ai_function_.

URL endpoint в именованной коллекции AI — это исходящий пункт назначения, к которому сервер подключается от своего имени, потенциально передавая (если указан) api_key этой именованной коллекции в заголовках запроса. По умолчанию ClickHouse разрешает любой хост. Чтобы ограничить функции определённым набором провайдеров, настройте remote_url_allow_hosts в конфигурации сервера, например:

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

Обратите внимание, что этот параметр является общесерверным и применяется ко всем возможностям, использующим HTTP.

Способ передачи определяется исключительно схемой URL endpoint. Шифрования полезной нагрузки запроса на уровне приложения нет; защита данных при передаче полностью зависит от схемы:

• https:// — соединение использует TLS. Тело запроса (входной текст, промпты) и api_key в заголовках запроса шифруются при передаче, а сертификат провайдера проверяется. Используйте этот вариант для любого удалённого провайдера.
• http:// — соединение не шифруется. Тело запроса и api_key передаются в открытом виде. Используйте этот вариант только для доверенного провайдера в частной сети (например, для локального экземпляра vLLM или Ollama).

По умолчанию функции ИИ отклоняют endpoint, который отправлял бы данные в открытом виде на удалённый хост: любая конечная точка, отличная от HTTPS, хост которой не является loopback-адресом, вызывает исключение. Loopback-хосты (localhost, 127.0.0.0/8, ::1) являются исключением, поэтому локальный сервер моделей http://localhost работает без дополнительной настройки. Чтобы разрешить незашифрованную конечную точку http:// на удалённом хосте, установите ai_function_allow_insecure_endpoint в значение 1. Эта проверка не зависит от remote_url_allow_hosts: эта настройка представляет собой список разрешённых хостов и не проверяет схему URL, поэтому конечная точка http://, указывающая на разрешённый хост, всё равно проходит её.

Обратите внимание: в обоих случаях провайдер получает входные данные в открытом виде после завершения TLS; TLS защищает данные только на сетевом участке между сервером и провайдером.

Активность функции ИИ отслеживается через 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.

Учетные данные (именованная коллекция, задающая провайдера, модель, конечную точку и, при необходимости, ключ API) берутся из ключа credentials в необязательной карте параметров или из настройки ai_function_text_default_credentials, если в карте этот ключ отсутствует.

Синтаксис

aiClassify(text, categories[, params])

Псевдонимы: AIClassify

Аргументы

• text — Текст для классификации. String
• categories — Константный список возможных меток категорий. Array(String)
• params — Необязательный константный набор параметров Map(String, String). Ключи, специфичные для функции: temperature (температура сэмплирования, влияющая на случайность; по умолчанию 0.0), max_tokens (максимальное количество выходных токенов за один вызов; по умолчанию 1024). Также применяются общие параметры credentials и model (см. функции ИИ). 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). В пределах одного блока строк входные данные группируются в батчи до ai_function_embedding_max_batch_size записей на один HTTP-запрос, чтобы сократить накладные расходы на каждый вызов.

Учетные данные (именованная коллекция, задающая провайдера, конечную точку и, при необходимости, ключ API) берутся из ключа credentials карты параметров или из настройки ai_function_embedding_default_credentials, если в карте этот ключ отсутствует. Обратите внимание, что aiEmbed использует отдельную настройку учетных данных по умолчанию, отличную от той, что используется текстовыми функциями, поскольку конечная точка для эмбеддингов отличается от конечной точки чата.

model — обязательный позиционный аргумент (константный String). В отличие от текстовых функций, aiEmbed не считывает model из именованной коллекции или карты параметров. Именованная коллекция, в которой задан model, отклоняется.

Необязательный параметр dimensions, если он поддерживается моделью (например, в OpenAI text-embedding-3-*), запрашивает вектор указанного размера; в противном случае возвращается собственная размерность модели.

Синтаксис

aiEmbed(text, model[, params])

Псевдонимы: AIEmbed

Аргументы

• text — Текст для получения эмбеддинга. String
• model — Имя модели эмбеддингов. const String
• params — Необязательная константа Map(String, String) с параметрами. Специфичный для функции ключ: dimensions (целевая размерность выходного вектора; 0 или отсутствие значения означает исходную размерность модели). Также применяется общий параметр credentials (см. Функции ИИ). Map(String, String)

Возвращаемое значение

Эмбеддинг-вектор или пустой массив, если входное значение равно NULL или пусто, запрос завершился с ошибкой и ai_function_throw_on_error отключён, либо была превышена квота при отключённом ai_function_throw_on_quota_exceeded. Array(Float32)

Примеры

Эмбеддинг одной строки (credentials можно опустить, если задана настройка ai_function_embedding_default_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.

Третий аргумент может быть либо произвольной инструкцией на естественном языке (например, 'the main complaint'), либо JSON-кодированной схемой вида '{"field_a": "description of field a", "field_b": "description of field b"}'.

В режиме инструкции функция возвращает извлечённое значение в виде обычной строки или пустую строку, если ничего не найдено. В режиме схемы функция возвращает строку с объектом JSON, ключи которого соответствуют запрошенной схеме; отсутствующие поля имеют значение null.

Учетные данные (именованная коллекция, задающая провайдера, модель, конечную точку и, при необходимости, ключ API) берутся из ключа credentials необязательной карты параметров или из настройки ai_function_text_default_credentials, если в карте этот ключ отсутствует.

Синтаксис

aiExtract(text, instruction_or_schema[, params])

Псевдонимы: AIExtract

Аргументы

• text — Текст, из которого нужно извлечь информацию. String
• instruction_or_schema — Инструкция для извлечения в свободной форме или константный объект JSON, описывающий извлекаемые поля. const String
• params — Необязательный константный Map(String, String) параметров. Ключи, специфичные для функции: temperature (температура сэмплирования, определяющая степень случайности; по умолчанию 0.0), max_tokens (максимальное количество выходных токенов за один вызов; по умолчанию 1024). Также применяются общие параметры credentials и model (см. функции ИИ). 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 и возвращает булево значение (UInt8), пригодное для использования в WHERE, PREWHERE и JOIN ... ON.

Функция запрашивает у модели ответ только в виде true или false в нижнем регистре. Любой полный ответ, отличный от true (включая false и нераспознанный текст), преобразуется в 0, поэтому строка отфильтровывается. Неполный ответ, о котором сообщает провайдер — усечённый, отфильтрованный по содержимому или требующий дальнейших действий, — вместо этого рассматривается как ошибка: при включённом ai_function_throw_on_error (по умолчанию) запрос прерывается; при отключённом параметре строка преобразуется в 0 и отфильтровывается.

Предупреждение: Не доверяйте результатам aiFilter без тщательной проверки. Предикаты на основе LLM могут быть некорректными или непоследовательными; используйте их только там, где допустимы ложноположительные и ложноотрицательные срабатывания.

Учётные данные (именованная коллекция, содержащая провайдера, модель, конечную точку и, при необходимости, ключ API) берутся из ключа credentials необязательной карты параметров или из настройки ai_function_text_default_credentials, если карта не содержит этого ключа.

Примечание: при использовании aiFilter в JOIN ... ON LLM вызывается один раз для каждой пары кандидатов, что может быть затратно.

Синтаксис

aiFilter(text, condition[, params])

Псевдонимы: AIFilter

Аргументы

• text — Текст для оценки. String
• condition — Постоянное условие на естественном языке, которому должен удовлетворять текст. String
• params — Необязательный постоянный Map(String, String) параметров. Специфичные для функции ключи: temperature (температура сэмплирования, определяющая случайность; по умолчанию 0.0), max_tokens (максимальное количество выходных токенов за один вызов; по умолчанию 1024). Также применяются общие параметры credentials и model (см. функции ИИ). Map(String, String)

Возвращаемое значение

1, если текст соответствует условию, иначе 0. Возвращает значение по умолчанию (0), если запрос завершился ошибкой и ai_function_throw_on_error отключён. 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-провайдеру и возвращает сгенерированный текст.

Учетные данные (именованная коллекция с указанием провайдера, модели, конечной точки и, при необходимости, ключа API) берутся из ключа credentials необязательной карты параметров или из настройки ai_function_text_default_credentials, если этот ключ в карте отсутствует.

Необязательная карта параметров также может задавать system_prompt (инструкцию, определяющую поведение модели, например тон, формат или роль), 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 (максимальное число выходных токенов за один вызов; по умолчанию 1024), system_prompt (константная системная инструкция, определяющая поведение модели; по умолчанию — общий промпт ассистента). Также применяются общие параметры credentials и model (см. функции ИИ). 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

Обнаруживает и маскирует персональные данные (PII) в заданном тексте с помощью провайдера LLM.

Каждый обнаруженный диапазон PII заменяется токеном маскирования (по умолчанию [REDACTED], настраивается через параметр replacement). Массив categories ограничивает типы маскируемых PII; пустой массив использует набор распространённых категорий по умолчанию (имя, email, номер телефона, адрес, кредитная карта, IP-адрес).

aiRedact предписывает модели изменять только обнаруженные диапазоны PII, однако сохранение окружающего текста также выполняется в меру возможностей, поэтому модель всё равно может его изменить (см. предупреждение выше). Управляющие символы, кроме табуляции, перевода строки и возврата каретки, перед отправкой запроса также заменяются пробелами, поэтому вывод не является побайтно идентичным входным данным, содержащим такие символы.

Поскольку 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']). При пустом массиве используется набор распространённых категорий по умолчанию (имя, электронная почта, номер телефона, адрес, кредитная карта, IP-адрес). Array(String)
• params — Необязательный постоянный Map(String, String) параметров. Специфичные для функции ключи: temperature (температура сэмплирования, управляющая случайностью; по умолчанию 0.0), max_tokens (максимальное количество выходных токенов за один вызов; по умолчанию 1024 — поскольку aiRedact возвращает полный текст, задайте значение больше длины входного текста в токенах; ответ, усечённый из-за слишком низкого ограничения, отклоняется вместо возврата частично замаскированного текста), replacement (токен, заменяющий каждый обнаруженный фрагмент PII; по умолчанию [REDACTED]). Также применяются общие параметры credentials и model (см. Функции ИИ). 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

Вычисляет семантическое сходство двух текстов с помощью настроенного провайдера эмбеддингов.

Вычисляет векторные эмбеддинги обоих текстов и возвращает их косинусное сходство. Оценка -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 — Первый текст. String
• text2 — Второй текст. String
• model — Имя модели эмбеддингов. const String
• params — Необязательный константный Map(String, String) параметров. Ключ, специфичный для этой функции: dimensions (целевая размерность эмбеддингов; 0 или отсутствие значения означает собственную размерность модели). Также применяется общий параметр credentials (см. функции ИИ). Map(String, String)

Возвращаемое значение

Косинусное сходство в диапазоне [-1, 1] или NULL, если один из текстов имеет значение NULL или пуст, запрос на создание эмбеддинга завершился ошибкой при отключённом ai_function_throw_on_error либо квота была превышена при отключённом ai_function_throw_on_quota_exceeded. Nullable(Float32)

Примеры

Сравнение двух строк (credentials можно не указывать, если задана настройка ai_function_embedding_default_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

Семантическая дедупликация с использованием self-join

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 в карте параметров (например, 'keep technical terms untranslated').

Учетные данные (именованная коллекция, задающая провайдера, модель, конечную точку и, при необходимости, ключ API) берутся из ключа 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 (максимальное количество выходных токенов за один вызов; по умолчанию 1024), instructions (дополнительные указания по стилю или диалекту для переводчика). Также применяются общие параметры credentials и model (см. Функции ИИ). 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