Coze StudioでOceanBaseベクトルデータベースを使用したベクトルストレージと検索

Coze Studioは、ワンストップAIエージェント開発ツールです。最新のさまざまな大規模言語モデルやツール、多様な開発モードとフレームワークを提供し、開発からデプロイまで、最も便利なAIエージェント開発環境を実現します。 本記事では、Coze StudioでOceanBaseベクトルデータベースを設定し、ベクトルストレージと検索に使用する方法について説明します。

バージョン互換性

• OceanBaseデータベースバージョン ≥ V4.3.3

前提条件

Coze StudioをOceanBaseベクトルデータベースと統合する前に、次のことを確認してください：

• OceanBaseデータベースのデプロイが完了し、MySQLモードのユーザーテナントが作成されていること。テナント作成の詳細については、テナントの作成を参照してください。
• ベクトル検索機能を有効にするため、テナントでob_vector_memory_limit_percentage構成パラメータが設定されていること。V4.3.5 BP3より前のバージョンでは値を30に設定することを推奨しますが、V4.3.5 BP3以降のバージョンではデフォルト値の0のままにすることを推奨します。この構成パラメータをより正確に設定する必要がある場合は、ob_vector_memory_limit_percentage を参照してこの値を計算してください。
• Dockerのデプロイが完了し、Dockerサービスが実行中であり、現在のユーザーがdockerコマンドを実行する権限を持っていること(docker infoで確認可能)。

手順

ステップ１：データベース接続文字列の取得

OceanBaseデータベースのデプロイ担当者から接続文字列を取得します。例：

obclient -h$host -P$port -u$user_name -p$password -D$database_name

パラメータ説明：

• $host：接続IPアドレス。ODP接続はODPアドレスを使用し、直接接続はOBServer IPを使用します。
• $port：接続ポート。ODPのデフォルトは2883、直接接続のデフォルトは2881です。
• $database_name：データベース名。

  注意

  テナントに接続するユーザーには、データベースに対する CREATE、INSERT、DROP、および SELECT 権限が付与されていなければなりません。ユーザー権限の詳細については、MySQLモードの権限分類を参照してください。

• $user_name：接続アカウント。ODP形式：ユーザー@テナント#クラスタまたはクラスタ:テナント:ユーザー。直接接続形式：ユーザー@テナント。
• $password：アカウントのパスワード。

接続文字列の詳細については、OBClientを使用してOceanBaseテナントに接続するを参照してください。

例：

obclient -hxxx.xxx.xxx.xxx -P2881 -u$user_name@$tenant_name -p****** -D$database_name

ステップ2：Coze Studioのデプロイ

1. ローカルプロジェクトで以下のコマンドを実行し、Coze Studioの最新バージョンのソースコードを取得します。

   git clone https://github.com/coze-dev/coze-studio.git
   

2. Coze Studioを初めてデプロイして起動するには、イメージをプルしてローカルイメージをビルドする必要があり、時間がかかる場合があります。しばらくお待ちください。

   cd coze-studio
   make web
   

3. docker/.envファイルを変更し、OceanBaseの情報を設定します。

   export WEB_LISTEN_ADDR="127.0.0.1:8888" # To enable remote access, use 0.0.0.0:8888.
   
   ########必須項目######## ##
   VECTOR_STORE_TYPE=oceanbase
   
   # OceanBase接続設定
   OCEANBASE_HOST=$host
   OCEANBASE_PORT=$port
   OCEANBASE_USER=$user_name
   OCEANBASE_PASSWORD=$password
   OCEANBASE_DATABASE=$database_name
   
   ########オプション項目######## ##
   # パフォーマンス最適化設定
   OCEANBASE_VECTOR_MEMORY_LIMIT_PERCENTAGE=30
   OCEANBASE_BATCH_SIZE=100
   OCEANBASE_MAX_OPEN_CONNS=100
   OCEANBASE_MAX_IDLE_CONNS=10
   
   # キャッシュ設定
   OCEANBASE_ENABLE_CACHE=true
   OCEANBASE_CACHE_TTL=300
   
   # モニタリング設定
   OCEANBASE_ENABLE_METRICS=true
   OCEANBASE_ENABLE_SLOW_QUERY_LOG=true
   
   # 再試行設定
   OCEANBASE_MAX_RETRIES=3
   OCEANBASE_RETRY_DELAY=1
   OCEANBASE_CONN_TIMEOUT=30
   

   パラメータ説明：

   $host：OceanBaseデータベースの接続IPアドレス。 $port：OceanBaseデータベースの接続ポート。 $user_name：OceanBaseデータベースのユーザー名。 $password：OceanBaseデータベースのユーザーパスワード。 $database_name：OceanBaseのデータベース名。

4. Coze Studioを起動します。

   docker compose -f ./docker/docker-compose-oceanbase.yml up -d
   

   「Container coze-server Started」というメッセージが表示されたら、Coze Studioサービスが正常に起動したことを意味します。

ステップ3：Coze Studioの使用

1. アカウント登録

http://localhost:8888/signにアクセスし、ユーザー名とパスワードを入力して登録ボタンをクリックします。

2. モデルの設定

http://localhost:8888/admin/#model-managementにアクセスし、必要に応じてモデルの追加を行います。

3. ナレッジベースの作成

   • Coze Studiohttp://localhost:8888/にアクセスします。
   • Coze Studioに入り、エージェントを作成します。
   • 作成したエージェントでナレッジベースの作成を選択します。
   • 作成後、ドキュメントのアップロードを行い、ベクトル化します。
   • エージェントに追加し、ナレッジQ&Aテストを行います。