メインコンテンツまでスキップ

Quickstart to External Data Lake Search

External data lake search を使用すると、外部ストレージまたは Zilliz Cloud にインポートされたデータへゼロコピーでアクセスし、コンピューティングリソースを常時稼働させることなく大規模なデータセットを検索できます。外部ボリュームやインポート済みファイルからコレクションを作成し、プロジェクトデータプレーンエンドポイント経由でインデックスの構築とメタデータの更新を行い、検索やクエリを実行する際にのみオンデマンドクラスターを起動できます。

手順は以下のとおりです。

始める前に​

  • ストレージ統合を作成します。

    ストレージ統合は、アクセス認証情報とともにデータの保存場所を登録するプロファイルです。ストレージ統合を設定するには、AWS S3、Google GCS、または Azure のストレージ統合を作成する手順に従い、ストレージ統合 ID を取得してください。

  • 外部ボリュームを作成します。

    外部ボリュームは、ストレージ統合内のパスです。生データがそのパスに配置されていることを確認してください。同じストレージ統合から複数の外部ボリュームを作成できます。外部ボリュームの作成については、External Volumes を参照してください。

ステップ 1: プロジェクトエンドポイントに接続する​

データベースを操作する前に、プロジェクトエンドポイントに接続します。プロジェクトエンドポイントは、Zilliz Cloud コンソールでオンデマンドコンピューティングを有効にした後、クイックスタートページで取得できます。

📘Notes

外部コレクションの操作には、認証に API key が必要です。このフローでは username:password 認証はサポートされていません。

python
# connect to database
client = MilvusClient(
    # a project-specific on-demand compute endpoint
    uri="https://{project-id}.{region}.api.zillizcloud.com",
    token="YOUR_API_KEY"
)

ステップ 2: (オプション) データベースを作成する​

Zilliz Cloud にはデフォルトのデータベースが用意されています。デフォルトのデータベースを使用する場合は、このステップをスキップしてください。以下のように新しいデータベースを作成することもできます。

python
client.create_database(
    db_name="my_database"
)

ステップ 3: 外部コレクションを作成する​

データベースの準備ができたら、外部コレクションを作成できます。外部コレクションは、指定したデータファイルにカラムをマッピングし、そのコレクションでの検索用にオンデマンドのコンピューティングリソースを割り当てます。

生データをコレクションにインポートする必要があるマネージドコレクションとは異なり、外部コレクションはサブ秒級の更新操作によって生データからメタデータを生成します。

次の例は、コレクションフィールドとデータファイルのマッピング関係を設定する方法を示しています。スキーマ作成時に、ボリュームパスとデータ形式を指定します。このクイックスタートでは Iceberg テーブルを使用します。サポートされているデータソースと形式の完全なリストについては、Supported data sources and formats を参照してください。

python
from pymilvus import MilvusClient, DataType

schema = MilvusClient.create_schema(
    external_source='volume://my_volume/iceberg/metadata/00001-xxx.metadata.json',
    external_spec='{
        "format": "iceberg-table",
        "snapshot_id": "1234567890123456789"
    }'
)

schema.add_field(
    field_name="vector",
    datatype=DataType.FLOAT_VECTOR,
    dim=1536,
    # highlight-next
    external_field="embedding" # field name in the external data file
)

schema.add_field(
    field_name="product_id",
    datatype=DataType.VARCHAR,
    max_length=32,
    nullable=True,
    # highlight-next
    external_field="product_id"
)

schema.add_field(
    field_name="title",
    datatype=DataType.VARCHAR,
    max_length=512,
    nullable=True,
    # highlight-next
    external_field="title"
)

schema.add_field(
    field_name="main_category",
    datatype=DataType.VARCHAR,
    max_length=64,
    nullable=True,
    # highlight-next
    external_field="main_category"
)

schema.add_field(
    field_name="price",
    datatype=DataType.DOUBLE,
    nullable=True,
    # highlight-next
    external_field="price"
)

schema.add_field(
    field_name="average_rating",
    datatype=DataType.DOUBLE,
    nullable=True,
    # highlight-next
    external_field="average_rating"
)

schema.add_field(
    field_name="rating_number",
    datatype=DataType.INT64,
    nullable=True,
    # highlight-next
    external_field="rating_number"
)

次に、上記のスキーマを使用してコレクションを作成できます。デフォルトのデータベースを使用する場合は、db_name パラメーターを省略しても問題ありません。

python
client.use_database(
    db_name="my_database"
)

# create the collection
client.create_collection(
    collection_name="my_collection",
    schema=schema
)

ステップ 4: インデックスの作成とコレクションのリフレッシュ​

外部データベースでも、マネージドコレクションと同様にインデックスを作成できます。すべてのベクトルフィールドにはインデックスを作成する必要があり、高速なメタデータフィルタリングのために一部のスカラーフィールドにもインデックスを作成できます。ただし、インデックスを構築するには refresh を呼び出す必要があります。

python
index_params = client.prepare_index_params()

# Add indexes
index_params.add_index(
    field_name="vector",
    index_type="AUTOINDEX",
    metric_type="COSINE"
)

index_params.add_index(
    field_name="main_category", 
    index_type="AUTOINDEX"
)

client.create_index(
    db_name="my_database",
    collection_name="my_collection",
    index_params=index_params
)

次に、外部コレクションをリフレッシュします。externalSource と externalSpec を省略してコレクションスキーマを再利用するか、両方を指定して新しいソースからコレクションスキーマを更新できます。

python
# refresh the external database
job_id = client.refresh_external_collection(
    collection_name="my_collection"
)

続いて、進捗監視の呼び出しをラップするループを作成し、リフレッシュ操作の進捗状況を追跡できます。

python
progress = client.get_refresh_external_collection_progress(job_id=job_id)

ステップ 5: オンデマンドクラスターの作成​

外部コレクションの準備ができたら、オンデマンド検索を行うためにオンデマンドクラスターにアタッチする必要があります。次のコマンドはクラスターを作成し、その ID を返します。

bash
export CONTROL_PLANE_ENDPOINT="https://api.cloud.zilliz.com"

curl --request POST \
--url "${CONTROL_PLANE_ENDPOINT}/v2/clusters/createOnDemandCluster" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "projectId": "proj-xxxxxxxxxxxxxxxxxxx",
    "regionId": "aws-us-west-2",
    "clusterName": "my-on-demand",
    "cuSize": 8,
    "autoSuspend": 60
}'

# inxx-xxxxxxxxxxxxx

デフォルトでは、クラスターは最後のリクエストから 60 秒後に自動的にサスペンドされますが、ユースケースに合わせてこの値を設定できます。

ステップ 6: 検索の実行​

検索、クエリ、またはハイブリッド検索を実行する際は、セッションを通じて前のステップで作成したオンデマンドクラスターに接続できます。

python
session = client.session(
    cluster_id="inxx-xxxxxxxxxxxxx"
)

# 1536-dimensional vector
query_vector = [0.3580376395471989, -0.6023495712049978, 0.18414012509913835, -0.26286205330961354, ..., 0.9029438446296592]
res = session.search(
    db_name="my_database",
    collection_name="my_collection",
    anns_field="vector",
    data=[query_vector],
    limit=3,
    output_fields=["product_id", "title", "main_category", "price", "average_rating", "rating_number"]
)

データを探索して最も価値のあるサブセットを見つけたら、サービングクラスターに接続してデータをインポートし、本番環境で提供できるようになります。

Ctrl I