オンデマンド DQL 操作

Public Preview

コレクション内のオンデマンドコンピューティング向け DQL 操作（検索、クエリ、取得、ハイブリッド検索など）では、オンデマンドクラスターからコンピューティングリソースをアタッチする必要があります。Zilliz Cloud では、オンデマンドのコンピューティングニーズを満たすセッションを作成できます。

この記事では、プロジェクトエンドポイントを使用してデータベース内にコレクションを作成済みであることを前提としています。詳細は、外部コレクションの作成を参照してください。

プロジェクトエンドポイントへの接続

プロジェクトエンドポイントは、オンデマンドコンピューティングリソースへのアクセスを提供するように設計されています。これを使用して、オンデマンドクラスターとデータベースを管理し、コレクションに保存されたデータを操作できます。

次のコード例では、デフォルトデータベース内に my_collection という名前の外部コレクションがあることを前提としています。また、接続を確立する際は、十分な権限を持つ有効な API キーを常に使用してください。

python
client = MilvusClient(
    uri="https://{project-id}.{region}.vectordb.zillizcloud.com",
    token="YOUR_API_KEY"
)

client.has_collection(
    collection_name="my_collection"
)

java
import io.milvus.v2.client.ConnectConfig;
import io.milvus.v2.client.MilvusClientV2;
import io.milvus.v2.service.collection.request.HasCollectionReq;
import io.milvus.v2.client.MilvusClientV2Session;
import io.milvus.v2.service.vector.request.SearchReq;
import io.milvus.v2.service.vector.request.data.FloatVec;
import io.milvus.v2.service.vector.response.SearchResp;
import java.util.*;

MilvusClientV2 client = new MilvusClientV2(ConnectConfig.builder()
        .uri("https://{project-id}.{region}.vectordb.zillizcloud.com")
        .token("YOUR_API_KEY")
        .build());
client.hasCollection(HasCollectionReq.builder().collectionName("my_collection").build());

// Note: the cluster session is not yet supported in milvus-sdk-go.

rust
use milvus::v2::prelude::*;

let client = ClientV2::new(
    &ConnectConfig::new()
        .uri("https://{project-id}.{region}.vectordb.zillizcloud.com")
        .token("YOUR_API_KEY"),
)
.await?;

let has = client
    .has_collection(HasCollectionRequest::builder().collection_name("my_collection").build()?)
    .await?;

c++
#include "milvus/MilvusClientV2.h"

auto client = milvus::MilvusClientV2::Create();
auto status = client->Connect(milvus::ConnectParam("https://{project-id}.{region}.vectordb.zillizcloud.com", "YOUR_API_KEY"));

bool has = client->HasCollection("my_collection");

javascript
import { MilvusClient } from "@zilliz/milvus2-sdk-node";

const client = new MilvusClient({
    address: "https://{project-id}.{region}.vectordb.zillizcloud.com",
    token: "YOUR_API_KEY"
});

client.hasCollection({
    collection_name: "my_collection"
});

csharp
using Milvus.Client.V2;
using Milvus.Client.V2.Requests.Collection;

var client = new MilvusClientV2(new ConnectConfig
{
    Uri = "https://{project-id}.{region}.vectordb.zillizcloud.com",
    ApiKey = "YOUR_API_KEY"
});
await client.ConnectAsync();

var has = await client.HasCollectionAsync(new HasCollectionReq { CollectionName = "my_collection" });

bash
export PROJECT_ENDPOINT='https://{project-id}.{region}.vectordb.zillizcloud.com'
export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${PROJECT_ENDPOINT}/v2/vectordb/collections/has" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "my_collection"
}'

セッションの作成

プロジェクトエンドポイントへの接続を確立したら、指定したオンデマンドクラスターからコンピューティングリソースをアタッチするセッションを作成します。

次の例では、ID が inxx-xxxxxxxxxxxxxxxxx のオンデマンドクラスターをすでに作成していることを前提としています。

Notes

RESTful リクエストの場合は、セッションを作成する代わりに、クラスター ID をクエリパラメーターとして DQL 呼び出しに渡してください。

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

java

MilvusClientV2Session session = client.session("inxx-xxxxxxxxxxxxxxxxx");

// Note: the cluster session is not yet supported in milvus-sdk-go.

rust
let session = client.session("inxx-xxxxxxxxxxxxxxxxx")?;

c++

milvus::MilvusClientV2SessionPtr session;
status = client->Session("inxx-xxxxxxxxxxxxxxxxx", session);

javascript
const session = client.session("inxx-xxxxxxxxxxxxxxxxx");

csharp

// Note: the cluster session is not yet supported in milvus-sdk-csharp as of v3.0.0.

bash

export CLUSTER_ID="inxx-xxxxxxxxxxxxxxxxx"

DQL 操作の実行

セッションの準備ができたら、検索を実行できます。次の例では、基本的なベクトル検索を例として使用しています。これは、クエリ、取得、ハイブリッド検索にも当てはまります。

python
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"]
)

java
FloatVec queryVector = new FloatVec(new float[]{0.3580376395471989f, -0.6023495712049978f, 0.18414012509913835f, -0.26286205330961354f, 0.9029438446296592f});

SearchReq searchReq = SearchReq.builder()
        .databaseName("my_database")
        .collectionName("my_collection")
        .data(Collections.singletonList(queryVector))
        .annsField("vector")
        .topK(3)
        .outputFields(Arrays.asList("product_id", "title", "main_category", "price", "average_rating", "rating_number"))
        .build();

SearchResp searchResp = session.search(searchReq);

// Note: the cluster session is not yet supported in milvus-sdk-go.

rust
let query_vector = vec![0.3580376395471989, -0.6023495712049978, 0.18414012509913835, -0.26286205330961354, 0.9029438446296592];

let res = session
    .search(
        SearchRequest::builder()
            .database_name("my_database")
            .collection_name("my_collection")
            .vector_field("vector")
            .vectors(SearchVectors::Float(vec![query_vector]))
            .limit(3)
            .output_fields(["product_id", "title", "main_category", "price", "average_rating", "rating_number"])
            .build()?,
    )
    .await?;

c++
std::vector<float> queryVector = {
    0.35803764F, -0.60234958F, 0.18414013F, -0.26286206F, 0.90294385F
};

auto request = milvus::SearchRequest()
    .WithDatabaseName("my_database")
    .WithCollectionName("my_collection")
    .WithAnnsField("vector")
    .WithLimit(3)
    .AddOutputField("product_id")
    .AddOutputField("title")
    .AddFloatVector(queryVector);

milvus::SearchResponse response;
status = session->Search(request, response);

javascript
const query_vector = [0.3580376395471989, -0.6023495712049978, 0.18414012509913835, -0.26286205330961354, 0.9029438446296592];
const 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"],
});

csharp

// Note: the cluster session is not yet supported in milvus-sdk-csharp as of v3.0.0.

bash
curl --request POST \
--url "${PROJECT_ENDPOINT}/v2/vectordb/entities/search?cluster_id=inxx-xxxxxxxxxxxxxxxxx" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "my_database",
    "collectionName": "my_collection",
    "data": [
        [
            0.3580376395471989,
            -0.6023495712049978,
            0.18414012509913835,
            -0.26286205330961354,
            0.9029438446296592
        ]
    ],
    "annsField": "vector",
    "limit": 3,
    "outputFields": [
        "product_id",
        "title",
        "main_category",
        "price",
        "average_rating",
        "rating_number"
    ]
}'

セッションの終了

オンデマンドのコンピューティングタスクが完了したら、セッションを終了できます。終了したセッションは、以降の DQL 操作には使用できません。

Notes

RESTful 呼び出しでは、これは必要ありません。

python
session.close()

java

session.close();

// Note: the cluster session is not yet supported in milvus-sdk-go.

rust
session.close();

c++

session->Close();

javascript
session.close();

csharp

// Note: the cluster session is not yet supported in milvus-sdk-csharp as of v3.0.0.

bash

# Note: the RESTful API does not maintain a persistent session; no explicit close is required.

プロジェクトエンドポイントへの接続​

セッションの作成​

DQL 操作の実行​

セッションの終了​

プロジェクトエンドポイントへの接続

セッションの作成

DQL 操作の実行

セッションの終了