【Databricks】Genie APIを用いてアプリを開発するための事前準備

Databricks Genie APIを使ってローカル環境でアプリ開発するための事前準備を解説。Genieスペースの作成からPersonal Access Tokenの取得、環境変数設定まで、自然言語でデータにアクセスできるアプリ開発に必要な手順を紹介します。

目次

はじめに

Databricks AI/BI Genieは、ユーザーが自然言語で問い合わせるとLLMが適切なデータを抽出、可視化してくれる機能です。SQLを書けないビジネスサイドのユーザーでもデータにアクセスし示唆を得ることができる点が非常に魅力的です。

[blogcard url=”https://www.databricks.com/jp/product/ai-bi/genie”]

GenieにはAPIが用意されています。Genie Conversation API(以後”Genie API”)を用いれば、外部アプリケーションからGenieを呼び出し、自然言語ベースでDatabricksのデータにアクセスすることができます。

[blogcard url=”https://docs.databricks.com/aws/ja/genie/conversation-api”]

本記事では、Genie APIを用いてローカル環境でアプリを開発するために必要な事前準備について詳細に説明します。Genieスペースの事前準備や環境変数の扱いなど、いくつか留意するべき点があります。是非参考にしてください。

STEP1: Genieスペースの準備

Genie APIを使うためにはまず「Genieスペース」を準備する必要があります。Genieスペースとは、Databricks UI上のGenieタブからアクセスできるチャットルームのようなものです。

[blogcard url=”https://docs.databricks.com/aws/ja/genie/”]

Genieスペースの作成方法については、以下の記事で詳しく紹介してくださっているので、参照してください。

[blogcard url=”https://qiita.com/taka_yayoi/items/b7ca4df53000afe9ba02″]

新しくスキーマを作る場合は、他のユーザーにアクセス権限(具体的にはUSE SCHEMA権限)を付与する必要がある点に注意が必要かと思います。

[blogcard url=”https://docs.databricks.com/aws/ja/data-governance/unity-catalog/manage-privileges/”]

STEP2: アクセストークンの入手

ローカル環境で開発するときにGenie APIを利用してGenieスペースにアクセスするためには、Personal Access Token (PAT) が必要です。

Databricksワークスペースにログインし、以下の手順でPATを新規作成しましょう。

右上のユーザーアイコン > Settings > Developer > Accecc Tokens の [Manage] をクリック > [Create new token] をクリック

何に使うトークンなのかを識別できるように適切にコメントをつけ、[Generate] をクリックすると新規PATが作成されます。

新たに作成したPATは、1度しか表示されないので安全な場所にメモしておいてください。

STEP3: ワークスペースID・GenieスペースIDの入手

Genie APIを利用してGenieスペースにアクセスするためには、DatabricksワークスペースのIDとアクセスしたいGenieスペースのIDが必要です。

 

それぞれ以下のIDを取得してください:

DatabricksワークスペースID:DatabricksワークスペースのURLの以下の部分

<DatabricksワークスペースID>/?o=xxxxxx(https~.comまで)

GenieスペースID:Genieスペースを開いたURLの以下の部分

https://<databricks-instance>/genie/rooms/<GenieスペースID>?o=xxxxxx(?o=の前まで)

STEP4: 環境変数の設定

プロジェクトのディレクトリで.env ファイルを作成し、先ほど取得したトークンやIDを以下のように記述します。

# ローカルからAPIを呼び出すためのPersonal Access Token
DATABRICKS_TOKEN="dapxxxxxxxxxxxxxxxx"
# DatabracksワークスペースのURL
DATABRICKS_HOST="<https://dbcxxxxxxxx.cloud.databricks.com>"
# 接続したいGenieスペースのID
GENIE_SPACE_ID="xxxxxxxxxxxxxxxx"

この環境変数をapp.py (あるいはmain.pyなど) から呼び出すために以下を記述してください。

from dotenv import load_dotenv

load_dotenv(".env")

HOST = os.getenv("DATABRICKS_HOST", "")
TOKEN = os.getenv("DATABRICKS_TOKEN", "")
SPACE_ID = os.getenv("GENIE_SPACE_ID", "")

Genie APIの使い方

ここまでの設定で、ローカル環境からGenieスペースにアクセスできるようになりました。

あとは実際にAPIを叩いてデータを取得するだけです!

今回はローカル環境でGenie APIを使えるようにするための事前設定に焦点を当てているので、実際のAPIの使い方については以下を参照してください。

おわりに

本記事では、Genie APIを用いてローカル環境でアプリを開発するために必要な事前準備について詳細に説明しました。Genie APIを使えば、SQLを書けないユーザが自然言語でデータを抽出できる機能を外部アプリに実装することが出来ます。ぜひ本記事を参考にしていただければと思います。

CTA
  • URLをコピーしました!
  • URLをコピーしました!
この記事を書いた人
目次