基盤モデルのクエリー

この記事では、基盤モデルのクエリ要求を書式設定し、モデルサービングエンドポイントに送信する方法について説明します。 Databricks によってホストされている基盤モデルと、Databricks の外部でホストされている基盤モデルに対してクエリを実行できます。

従来の機械学習または Python モデルのクエリリクエストについては、「カスタムモデルのサービングエンドポイントをクエリする」を参照してください。

Mosaic AI Model Servingは、基盤モデルにアクセスするための基盤モデルAPIsと外部モデルをサポートしています。モデルサービングは、統一されたOpenAI互換の API とクエリ SDK を使用します。これにより、エクスペリメントを行い、サポートされているクラウドやプロバイダー間での本番運用のための基盤モデルをカスタマイズすることが可能になります。

Mosaic AI Model Serving は、基盤モデルまたは外部モデルを提供するエンドポイントにスコアリングリクエストを送信するための次のオプションを提供します。

手法	詳細
OpenAI クライアント	OpenAI クライアントを使用して、 Mosaic AI Model Servingエンドポイントによってホストされているモデルをクエリします。 `model`入力としてモデルサーバーのエンドポイント名を指定します。基盤モデルAPIまたは外部モデルによって提供されるチャット、埋め込み、補完モデルがサポートされます。
SQL関数	`ai_query` SQL 関数を使用して、SQL から直接モデル推論を呼び出します。「 ai_query を使用した提供済みモデルのクエリ」を参照してください。
UI の提供	[サービスエンドポイント] ページから [クエリエンドポイント] を選択します。JSON 形式のモデル入力データを挿入し、「リクエストの送信」をクリックします。モデルに入力例がログに記録されている場合は、[ 例を表示 ]を使用して読み込みます。
REST API	REST API を使用してモデルを呼び出し、クエリを実行します。詳細は、 POST /serving-endpoints/{name}/invocations を参照してください。複数のモデルを提供するエンドポイントへの要求のスコアリングについては、「エンドポイントの背後にある個々のモデルをクエリする」を参照してください。
MLflow デプロイメント SDK	MLflow Deployments SDK のdetect()関数を使用してモデルをクエリします。
Databricks Python SDK	Databricks Python SDK は、REST API の上位レイヤーです。認証などの低レベルの詳細を処理するため、モデルとの対話が容易になります。

要件

A モデルサービングエンドポイント.
サポートされているリージョンの Databricks ワークスペース。
- 基盤モデルAPIのリージョン
- 外部モデルリージョン
OpenAI クライアント、REST API、または MLflow デプロイメント SDK を介してスコアリング要求を送信するには、Databricks API トークンが必要です。

重要

オンプレミス運用シナリオのセキュリティのベストプラクティスとして、 Databricksでは、オンプレミス運用中の認証にマシン間OAuthトークンを使用することをお勧めします。

テストと開発の場合、 Databricksでは、ワークスペースユーザーではなく、サービスプリンシパルに属する個人用アクセストークンを使用することをお勧めします。サービスプリンシパルのトークンを作成するには、「サービスプリンシパルのトークンの管理」を参照してください。

パッケージのインストール

クエリ方法を選択したら、まず適切なパッケージをクラスターにインストールする必要があります。

OpenAI クライアントを使用するには、 databricks-sdk[openai] パッケージをクラスターにインストールする必要があります。 Databricks SDK 、生成モデルのクエリを実行するように自動的に構成された承認を使用して OpenAI クライアントを構築するためのラッパーAI 提供されます。ノートブックまたはローカルターミナルで次のコマンドを実行します。

!pip install databricks-sdk[openai]>=0.35.0

以下は、Databricks ノートブックにパッケージをインストールする場合にのみ必要です

dbutils.library.restartPython()

Serving REST API へのアクセスは、Databricks Runtime for Machine Learning で利用できます。

!pip install mlflow

以下は、Databricks ノートブックにパッケージをインストールする場合にのみ必要です

dbutils.library.restartPython()

Databricks SDK for Python は、Databricks Runtime 13.3 LTS 以降を使用するすべての Databricks クラスターに既にインストールされています。 Databricks Runtime 12.2 LTS 以下を使用する Databricks クラスターの場合は、最初に Databricks SDK for Python をインストールする必要があります。「Databricks SDK for Python」を参照してください。

チャット補完モデルのクエリー

チャットモデルに対してクエリを実行する例を次に示します。この例は、モデルサービス機能 (基盤モデルAPIまたは外部モデル) のいずれかを使用して使用可能になったチャットモデルのクエリに適用されます。

バッチ推論の例については、「 ai_query を使用したバッチ LLM 推論の実行」を参照してください。

以下は、ワークスペースのトークン単位の従量課金の基盤モデルAPIのエンドポイント databricks-dbrx-instruct によって利用可能になる DBRX Instruct モデルに対するチャットリクエストです。

OpenAI クライアントを使用するには、 model 入力としてモデルサービングエンドポイント名を指定します。

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()
openai_client = w.serving_endpoints.get_open_ai_client()

response = openai_client.chat.completions.create(
    model="databricks-dbrx-instruct",
    messages=[
      {
        "role": "system",
        "content": "You are a helpful assistant."
      },
      {
        "role": "user",
        "content": "What is a mixture of experts model?",
      }
    ],
    max_tokens=256
)

ワークスペースの外部で基盤モデルをクエリするには、OpenAI クライアントを直接使用する必要があります。また、OpenAI クライアントを Databricks に接続するには、Databricks ワークスペースインスタンスも必要です。次の例では、 Databricks API トークンとopenaiがコンピュートにインストールされていることを前提としています。

import os
import openai
from openai import OpenAI

client = OpenAI(
    api_key="dapi-your-databricks-token",
    base_url="https://example.staging.cloud.databricks.com/serving-endpoints"
)

response = client.chat.completions.create(
    model="databricks-dbrx-instruct",
    messages=[
      {
        "role": "system",
        "content": "You are a helpful assistant."
      },
      {
        "role": "user",
        "content": "What is a mixture of experts model?",
      }
    ],
    max_tokens=256
)

重要

次の例では、REST API パラメーターを使用して、基盤モデルにサービスを提供するサービスエンドポイントをクエリします。これらのパラメーターはパブリックプレビューであり、定義は変更される可能性があります。 POST /serving-endpoints/{name}/invocations を参照してください。

以下は、ワークスペースのトークン単位の従量課金の基盤モデルAPIのエンドポイント databricks-dbrx-instruct によって利用可能になる DBRX Instruct モデルに対するチャットリクエストです。

curl \
-u token:$DATABRICKS_TOKEN \
-X POST \
-H "Content-Type: application/json" \
-d '{
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant."
    },
    {
      "role": "user",
      "content": " What is a mixture of experts model?"
    }
  ]
}' \
https://<workspace_host>.databricks.com/serving-endpoints/databricks-dbrx-instruct/invocations \

重要

次の例では、 MLflow Deployments SDKのpredict() API を使用します。

以下は、ワークスペースのトークン単位の従量課金の基盤モデルAPIのエンドポイント databricks-dbrx-instruct によって利用可能になる DBRX Instruct モデルに対するチャットリクエストです。

import mlflow.deployments

# Only required when running this example outside of a Databricks Notebook
export DATABRICKS_HOST="https://<workspace_host>.databricks.com"
export DATABRICKS_TOKEN="dapi-your-databricks-token"

client = mlflow.deployments.get_deploy_client("databricks")

chat_response = client.predict(
    endpoint="databricks-dbrx-instruct",
    inputs={
        "messages": [
            {
              "role": "user",
              "content": "Hello!"
            },
            {
              "role": "assistant",
              "content": "Hello! How can I assist you today?"
            },
            {
              "role": "user",
              "content": "What is a mixture of experts model??"
            }
        ],
        "temperature": 0.1,
        "max_tokens": 20
    }
)

以下は、ワークスペースのトークン単位の従量課金の基盤モデルAPIのエンドポイント databricks-dbrx-instruct によって利用可能になる DBRX Instruct モデルに対するチャットリクエストです。

このコードはワークスペース内のノートブックで実行する必要があります。「Databricks ノートブックから Databricks SDK for Python を使用する」を参照してください。

from databricks.sdk import WorkspaceClient
from databricks.sdk.service.serving import ChatMessage, ChatMessageRole

w = WorkspaceClient()
response = w.serving_endpoints.query(
    name="databricks-dbrx-instruct",
    messages=[
        ChatMessage(
            role=ChatMessageRole.SYSTEM, content="You are a helpful assistant."
        ),
        ChatMessage(
            role=ChatMessageRole.USER, content="What is a mixture of experts model?"
        ),
    ],
    max_tokens=128,
)
print(f"RESPONSE:\n{response.choices[0].message.content}")

LangChain を使用して基盤モデルのエンドポイントをクエリするには、ChatDatabricks ChatModel クラスを使用し、endpointを指定できます。

次の例では、 LangChain の ChatDatabricks ChatModel クラスを使用して、トークン単位の従量課金エンドポイント databricks-dbrx-instruct APIs 基盤モデルをクエリします。

%pip install databricks-langchain

from langchain_core.messages import HumanMessage, SystemMessage
from databricks_langchain import ChatDatabricks

messages = [
    SystemMessage(content="You're a helpful assistant"),
    HumanMessage(content="What is a mixture of experts model?"),
]

llm = ChatDatabricks(endpoint_name="databricks-dbrx-instruct")
llm.invoke(messages)

重要

次の例では、組み込み SQL 関数 ai_query を使用しています。この機能はパブリックプレビューであり、定義は変更される可能性があります。「 ai_query を使用した提供済みモデルのクエリ」を参照してください。

以下は、ワークスペースのトークン単位の従量課金の基盤モデルAPIエンドポイント databricks-meta-llama-3-1-70b-instruct によって利用可能になる、meta-llama-3-1-70b-instruct へのチャットリクエストです。

注：

ai_query() 関数は、DBRX または DBRX Instruct モデルを提供するクエリエンドポイントをサポートしません。

SELECT ai_query(
    "databricks-meta-llama-3-1-70b-instruct",
    "Can you explain AI in ten words?"
  )

例として、REST API を使用する場合のチャットモデルの予想されるリクエスト形式を次に示します。外部モデルの場合、特定のプロバイダーおよびエンドポイント構成に有効な追加のを含めることもできます。追加クエリを参照してください。

{
  "messages": [
    {
      "role": "user",
      "content": "What is a mixture of experts model?"
    }
  ],
  "max_tokens": 100,
  "temperature": 0.1
}

REST API を使用して行われたリクエストに対する予想される応答形式は次のとおりです。

{
  "model": "databricks-dbrx-instruct",
  "choices": [
    {
      "message": {},
      "index": 0,
      "finish_reason": null
    }
  ],
  "usage": {
    "prompt_tokens": 7,
    "completion_tokens": 74,
    "total_tokens": 81
  },
  "object": "chat.completion",
  "id": null,
  "created": 1698824353
}

エンべディングモデルのクエリー

以下は、基盤モデルAPIによって利用可能になった gte-large-en モデルの埋め込みリクエストです。この例は、モデルサービング機能 (基盤モデルAPIまたは外部モデル) のいずれかを使用して使用可能になった埋め込みモデルのクエリに適用されます。

OpenAI クライアントを使用するには、 model 入力としてモデルサービングエンドポイント名を指定します。

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()
openai_client = w.serving_endpoints.get_open_ai_client()

response = openai_client.embeddings.create(
  model="databricks-gte-large-en",
  input="what is databricks"
)

ワークスペースの外部で基盤モデルをクエリするには、以下に示すように、OpenAI クライアントを直接使用する必要があります。次の例では、コンピュートに Databricks API トークンと openai がインストールされていることを前提としています。また、OpenAI クライアントを Databricks に接続するには、Databricks ワークスペースインスタンスも必要です。

import os
import openai
from openai import OpenAI

client = OpenAI(
    api_key="dapi-your-databricks-token",
    base_url="https://example.staging.cloud.databricks.com/serving-endpoints"
)

response = client.embeddings.create(
  model="databricks-gte-large-en",
  input="what is databricks"
)

重要

次の例では、基盤モデルまたは外部モデルを提供するサービスエンドポイントを照会するためにREST APIヘッダーを使用します。これらはパブリックプレビューであり、定義は変更される可能性があります。 POST /serving-endpoints/{name}/invocationsを参照してください。

curl \
-u token:$DATABRICKS_TOKEN \
-X POST \
-H "Content-Type: application/json" \
-d  '{ "input": "Embed this sentence!"}' \
https://<workspace_host>.databricks.com/serving-endpoints/databricks-gte-large-en/invocations

重要

次の例では、 MLflow Deployments SDKのpredict() API を使用します。

import mlflow.deployments

export DATABRICKS_HOST="https://<workspace_host>.databricks.com"
export DATABRICKS_TOKEN="dapi-your-databricks-token"

client = mlflow.deployments.get_deploy_client("databricks")

embeddings_response = client.predict(
    endpoint="databricks-gte-large-en",
    inputs={
        "input": "Here is some text to embed"
    }
)

from databricks.sdk import WorkspaceClient
from databricks.sdk.service.serving import ChatMessage, ChatMessageRole

w = WorkspaceClient()
response = w.serving_endpoints.query(
    name="databricks-gte-large-en",
    input="Embed this sentence!"
)
print(response.data[0].embedding)

Databricksで基盤モデルモデルをAPIs LangChain埋め込みモデルとして使用するには、DatabricksEmbeddings クラスをインポートし、次のようにendpoint パラメーターを指定します。

%pip install databricks-langchain

from databricks_langchain import DatabricksEmbeddings

embeddings = DatabricksEmbeddings(endpoint="databricks-gte-large-en")
embeddings.embed_query("Can you explain AI in ten words?")

重要

次の例では、組み込み SQL 関数 ai_query を使用しています。この機能はパブリックプレビューであり、定義は変更される可能性があります。「 ai_query を使用した提供済みモデルのクエリ」を参照してください。

SELECT ai_query(
    "databricks-gte-large-en",
    "Can you explain AI in ten words?"
  )

以下は、エンべディングモデルで想定される要求形式です。外部モデルの場合、特定のプロバイダーおよびエンドポイント構成に有効な追加パラメーターを含めることができます。「追加のクエリ」を参照してください。

{
  "input": [
    "embedding text"
  ]
}

想定される応答形式は次のとおりです。

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": []
    }
  ],
  "model": "text-embedding-ada-002-v2",
  "usage": {
    "prompt_tokens": 2,
    "total_tokens": 2
  }
}

エンべディングが正規化されているかどうかを確認する

モデルによって生成されたエンべディングが正規化されているかどうかを確認するには、次を使用します。

  import numpy as np

  def is_normalized(vector: list[float], tol=1e-3) -> bool:
      magnitude = np.linalg.norm(vector)
      return abs(magnitude - 1) < tol

テキスト補完モデルのクエリー

重要

OpenAI クライアントを使用した基盤モデル APIs トークン単位の従量課金を使用して利用可能になったテキスト補完モデルのクエリはサポートされていません。このセクションで示すように、OpenAI クライアントを使用した外部モデルのクエリのみがサポートされています。

OpenAI クライアントを使用するには、 model 入力としてモデルサービングエンドポイント名を指定します。次の例では、OpenAI クライアントを使用して Anthropic によってホストされている claude-2 入力候補モデルに対してクエリを実行します。 OpenAI クライアントを使用するには、クエリを実行するモデルをホストするモデルサービングエンドポイントの名前を model フィールドに入力します。

この例では、Anthropic モデルプロバイダーから外部モデルにアクセスするために構成された、以前に作成したエンドポイント anthropic-completions-endpointを使用します。外部モデルのエンドポイントを作成する方法を参照してください。

クエリ可能なその他のモデルとそのプロバイダーについては、サポートされているモデルを参照してください。

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()
openai_client = w.serving_endpoints.get_open_ai_client()

completion = openai_client.completions.create(
model="anthropic-completions-endpoint",
prompt="what is databricks",
temperature=1.0
)
print(completion)

次に示すのは、外部モデルを使用して使用可能になった完了モデルをクエリするための入力候補リクエストです。

重要

次の例では REST API 外部モデルを提供する提供エンドポイントのクエリにパラメーターを使用します。これらのパラメーターはパブリックプレビューであり、定義は変更される可能性があります。 POST /serving-endpoints/{name}/invocationsを参照してください。

curl \
-u token:$DATABRICKS_TOKEN \
-X POST \
-H "Content-Type: application/json" \
-d '{"prompt": "What is a quoll?", "max_tokens": 64}' \
https://<workspace_host>.databricks.com/serving-endpoints/<completions-model-endpoint>/invocations

次に示すのは、外部モデルを使用して使用可能になった完了モデルをクエリするための入力候補リクエストです。

重要

次の例では、 MLflow Deployments SDKのpredict() API を使用します。

import os
import mlflow.deployments

# Only required when running this example outside of a Databricks Notebook

os.environ['DATABRICKS_HOST'] = "https://<workspace_host>.databricks.com"
os.environ['DATABRICKS_TOKEN'] = "dapi-your-databricks-token"

client = mlflow.deployments.get_deploy_client("databricks")

completions_response = client.predict(
    endpoint="<completions-model-endpoint>",
    inputs={
        "prompt": "What is the capital of France?",
        "temperature": 0.1,
        "max_tokens": 10,
        "n": 2
    }
)

# Print the response
print(completions_response)

以下は、外部モデルを使用して利用可能になった完了モデルをクエリするための完了要求です。

from databricks.sdk import WorkspaceClient
from databricks.sdk.service.serving import ChatMessage, ChatMessageRole

w = WorkspaceClient()
response = w.serving_endpoints.query(
    name="<completions-model-endpoint>",
    prompt="Write 3 reasons why you should train an AI model on domain specific data sets."
)
print(response.choices[0].text)

重要

次の例では、組み込み SQL 関数 ai_query を使用しています。この機能はパブリックプレビューであり、定義は変更される可能性があります。「 ai_query を使用した提供済みモデルのクエリ」を参照してください。

SELECT ai_query(
    "<completions-model-endpoint>",
    "Can you explain AI in ten words?"
  )

以下は、入力候補モデルで想定される要求形式です。外部モデルの場合、特定のプロバイダーおよびエンドポイント構成に有効な追加パラメーターを含めることができます。「追加のクエリ」を参照してください。

{
  "prompt": "What is mlflow?",
  "max_tokens": 100,
  "temperature": 0.1,
  "stop": [
    "Human:"
  ],
  "n": 1,
  "stream": false,
  "extra_params":
  {
    "top_p": 0.9
  }
}

想定される応答形式は次のとおりです。

{
  "id": "cmpl-8FwDGc22M13XMnRuessZ15dG622BH",
  "object": "text_completion",
  "created": 1698809382,
  "model": "gpt-3.5-turbo-instruct",
  "choices": [
    {
    "text": "MLflow is an open-source platform for managing the end-to-end machine learning lifecycle. It provides tools for tracking experiments, managing and deploying models, and collaborating on projects. MLflow also supports various machine learning frameworks and languages, making it easier to work with different tools and environments. It is designed to help data scientists and machine learning engineers streamline their workflows and improve the reproducibility and scalability of their models.",
    "index": 0,
    "logprobs": null,
    "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 5,
    "completion_tokens": 83,
    "total_tokens": 88
  }
}

AI Playground を使用してサポートされている LLM とチャットする

AI Playgroundを使用して、サポートされている大規模言語モデルと対話できます。 AI Playground Databricks ワークスペースから LLM をテスト、プロンプト、比較できるチャットのような環境です。

基盤モデルのクエリー

要件

パッケージのインストール

チャット補完モデルのクエリー

エンべディングモデルのクエリー

エンべディングが正規化されているかどうかを確認する

テキスト補完モデルのクエリー

AI Playground を使用してサポートされている LLM とチャットする

関連リソース