ai_query 函数

适用于： Databricks SQL Databricks Runtime

调用现有的 Azure Databricks 模型服务终结点，然后分析并返回其响应。

要求

• 此函数在 Azure Databricks SQL Classic 上不可用。
• 默认情况下，查询基础模型 API 处于启用状态。 若要查询提供自定义模型或外部模型的终结点，请为 Databricks 预览 UI 中的自定义模型和外部模型启用 AI_Query。
• 当前 DLT 仓库通道不使用支持 ai_query() 的最新 Databricks Runtime 版本。 将表属性中的 pipelines.channel 设置为 'preview'，以使用 ai_query()。 请参阅示例查询的示例。

语法

若要查询为外部模型或基础模型提供服务的终结点，请执行以下操作：

ai_query(endpointName, request)

若要查询具有模型架构的自定义模型服务终结点，请执行以下操作：

ai_query(endpointName, request)

若要查询没有模型架构的自定义模型服务终结点，请执行以下操作：

ai_query(endpointName, request, returnType)

参数

• endpointName：字符串字面量、Databricks 基础模型服务终结点的名称、同一工作区中用于调用的外部模型服务终结点或自定义模型终结点。 定义者必须对终结点具有“可查询”权限。
• request：一个表达式，是用于调用终结点的请求。
  • 如果终结点是一个外部模型服务终结点或 Databricks 基础模型 API 终结点，则请求必须是一个字符串。
  • 如果终结点是一个自定义模型服务终结点，则请求可以是单个列或结构表达式。 结构字段名称应与终结点所需的输入特征名称匹配。
• returnType：一个表达式，即来自终结点的预期 returnType。 这与 from_json 函数中的架构参数类似，它接受 STRING 表达式或 schema_of_json 函数的调用。
  • 在 Databricks Runtime 14.2 及更高版本中，如果未提供此表达式，则 ai_query() 会自动从自定义模型服务终结点的模型架构推断返回类型。
  • 在 Databricks Runtime 14.1 及更低版本中，查询自定义模型服务终结点需要此表达式。

返回

来自终结点的已分析响应。

示例

若要查询创建外部模型服务终结点：

> SELECT ai_query(
    'my-external-model-openai-chat',
    'Describe Databricks SQL in 30 words.'
  ) AS summary

  "Databricks SQL is a cloud-based platform for data analytics and machine learning, providing a unified workspace for collaborative data exploration, analysis, and visualization using SQL queries."

查询 Databricks Foundation 模型 API 支持的基础模型：

> SELECT *,
  ai_query(
    'databricks-meta-llama-3-1-70b-instruct',
    "Can you tell me the name of the US state that serves the provided ZIP code? zip code: " || pickup_zip
    )
  FROM samples.nyctaxi.trips
  LIMIT 10

（可选）还可以在 UDF 中包装对 ai_query() 的调用，以便调用函数，如下所示：

> CREATE FUNCTION correct_grammar(text STRING)
  RETURNS STRING
  RETURN ai_query(
    'databricks-llama-2-70b-chat',
    CONCAT('Correct this to standard English:\n', text));
> GRANT EXECUTE ON correct_grammar TO ds;
- DS fixes grammar issues in a batch.
> SELECT
    * EXCEPT text,
    correct_grammar(text) AS text
  FROM articles;

若要查询自定义模型服务终结点，请执行以下操作：

> SELECT text, ai_query(
    endpoint => 'spam-classification-endpoint',
    request => named_struct(
      'timestamp', timestamp,
      'sender', from_number,
      'text', text),
    returnType => 'BOOLEAN') AS is_spam
  FROM messages

> SELECT ai_query(
    'weekly-forecast',
    request => struct(*),
    returnType => 'FLOAT') AS predicted_revenue
  FROM retail_revenue

> SELECT ai_query(
    'custom-llama-2-7b-chat',
    request => named_struct("messages",
        ARRAY(named_struct("role", "user", "content", "What is ML?"))),
    returnType => 'STRUCT<candidates:ARRAY<STRING>>')

  {"candidates":["ML stands for Machine Learning. It's a subfield of Artificial Intelligence that involves the use of algorithms and statistical models to enable machines to learn from data, make decisions, and improve their performance on a specific task over time."]}

将 DLT 通道设置为预览的示例查询：

> create or replace materialized view
    ai_query_mv
    TBLPROPERTIES('pipelines.channel' = 'PREVIEW') AS
  SELECT
    ai_query("databricks-dbrx-instruct", text) as response
  FROM
    messages

相关函数

• from_json 函数
• schema_of_json 函数