OAuth トークンでベクター検索を使用する

このページのノートブック バージョンを開く

このノートブックでは、ベクター検索 SDK または HTTP を使用して、新しい OAuth トークンを使用してベクター検索エンドポイントを呼び出す方法を示します。 どちらの場合も、運用ワークロードに推奨されるように、ネットワーク最適化パスが使用されます。

トークンを作成してエンドポイントを呼び出すための HTTP 呼び出しは、選択した言語で実装できます。 運用アプリケーションの場合は、トークンを 60 分ごとに更新する必要があることに注意してください。 古いトークンによるエラーを防ぐために、Databricks では 60 分未満の間隔で更新することをお勧めします。

セットアップ

%pip install databricks-sdk
%pip install databricks-vectorsearch
dbutils.library.restartPython()

import requests
import json
import random
from databricks.sdk import WorkspaceClient
import logging

構成定数

サービス プリンシパルを作成する方法の詳細については、 Databricks のドキュメントを参照してください。

# Define the secret ID and secret for the service principal
CLIENT_ID = dbutils.secrets.get(scope="scope", key="service_principal_client_id")
CLIENT_SECRET = dbutils.secrets.get(scope="scope", key="service_principal_client_secret")

# You can get it by clicking the copy button next to the index name
INDEX_NAME="UC_CATALOG_INDEX_NAME"
ENDPOINT_NAME="ENDPOINT_NAME"

workspace_url = f"https://{spark.conf.get('spark.databricks.workspaceUrl')}"

Python クライアントを使用したクエリ ベクター検索

詳細については、 API のドキュメントを参照してください。

from databricks.vector_search.client import VectorSearchClient

vsc_dp = VectorSearchClient(
  service_principal_client_id=CLIENT_ID,
  service_principal_client_secret=CLIENT_SECRET,
  workspace_url=workspace_url)

index = vsc_dp.get_index(endpoint_name=ENDPOINT_NAME, index_name=INDEX_NAME)
index.similarity_search(["text"], query_vector=[0]*2560, num_results=5, debug_level=0)

HTTP 要求を使用してベクター検索を呼び出す

このセクションでは、HTTP を使用してベクター検索インデックスを呼び出す方法を示します。これを任意のツールまたは言語で実装できます。

API 呼び出しを使用して OAuth トークンを生成する

ネットワーク最適化パスを使用してエンドポイントを呼び出すには、OAuth トークンが必要です。 次のコードは、トークンを作成します。

url = f"{workspace_url}/oidc/v1/token"
deets = json.dumps([
                {
                    "type": "unity_catalog_permission",
                    "securable_type": "table",
                    "securable_object_name": INDEX_NAME,
                    "operation": ("ReadVectorIndex"),
                },
            ])
payload = { 'grant_type': 'client_credentials', 'scope': 'all-apis', 'authorization_details': deets}

response = requests.post(
    url=url,
    auth=(CLIENT_ID, CLIENT_SECRET),
    headers={"Content-Type": "application/x-www-form-urlencoded"},
    data=payload,
)
if response.status_code != 200:
    logging.error(f"OAuth token request failed: {response.status_code} - {response.text}")
    response.raise_for_status()

token_data = response.json()
access_token = token_data.get("access_token")
if not access_token:
    raise ValueError("Failed to get access token")

Python クライアントを使用したベクター検索のクエリ

JavaScript またはその他のツールを使用してベクター検索のクエリを実行するには、クエリを作成してベクター検索エンドポイントに送信します。

index = vsc_dp.get_index(endpoint_name=ENDPOINT_NAME, index_name=INDEX_NAME)
index_url = index.index_url
print(index_url)

headers = {"Authorization": f"Bearer {access_token}"}
payload = {
    "query_vector": [0]*2560,
    "num_results": 5,
    "columns": ["text"]}

response = requests.post(index_url+"/query", headers=headers, data=json.dumps(payload))
print(response.status_code)
print(json.dumps(response.json(), indent=2))

ノートブックの例

OAuth トークンでベクター検索を使用する

ノートブックを入手

  • Last updated on