Standard Analyzer

standard analyzer は Zilliz Cloud のデフォルト analyzer であり、analyzer が指定されていない場合はテキストフィールドに自動的に適用されます。標準の tokenizer と lowercase filter を組み合わせたものです。

Notes

standard analyzer は、単語境界に区切り文字（スペースや句読点など）を使用する言語に適しています。ただし、中国語、日本語、韓国語のような言語では辞書ベースの tokenization が必要です。そのような場合は、正確な tokenization とより良い検索結果を実現するために、chinese のような言語固有の analyzer、または専用の tokenizer（lindera、icu など）と filter を組み合わせたカスタム analyzer の使用を強く推奨します。

定義

standard analyzer は、次のコンポーネントで構成されます。

• Tokenizer: standard tokenizer を使用して、連続する Unicode の文字と数字を token に含め、それ以外の文字で分割します。正確な文字のルールについては、Standard Tokenizer を参照してください。

• Filter: lowercase filter を使用して、すべての token を小文字に変換し、大文字と小文字を区別しない検索を可能にします。詳細については、Lowercase を参照してください。

standard analyzer の機能は、次のカスタム analyzer 設定と同等です。

Python

python

analyzer_params = {
    "tokenizer": "standard",
    "filter": ["lowercase"]
}

Java

java

Map<String, Object> analyzerParams = new HashMap<>();
analyzerParams.put("tokenizer", "standard");
analyzerParams.put("filter", Collections.singletonList("lowercase"));

Go

go

analyzerParams := map[string]any{"tokenizer": "standard", "filter": []any{"lowercase"}}

Rust

rust

let analyzer_params = serde_json::json!({
    "tokenizer": "standard",
    "filter": ["lowercase"]
});

C++

c++

nlohmann::json analyzer_params = {
    {"tokenizer", "standard"},
    {"filter", {"lowercase"}},
};

NodeJS

javascript

const analyzer_params = {
    "tokenizer": "standard",
    "filter": ["lowercase"]
};

cURL

bash

# restful
analyzerParams='{
  "tokenizer": "standard",
  "filter": [
    "lowercase"
  ]
}'

設定

standard analyzer をフィールドに適用するには、analyzer_params で type を standard に設定し、必要に応じてオプションのパラメーターを含めるだけです。

Python

python

analyzer_params = {
    "type": "standard", # Specifies the standard analyzer type
}

Java

java

Map<String, Object> analyzerParams = new HashMap<>();
analyzerParams.put("type", "standard");

Go

go

analyzerParams = map[string]any{"type": "standard"}

Rust

rust

let analyzer_params = serde_json::json!({
    "type": "standard"
});

C++

c++

nlohmann::json analyzer_params = {
    {"type", "standard"},
};

NodeJS

javascript

const analyzer_params = {
    "type": "standard", // Specifies the standard analyzer type
}

cURL

bash

# restful
analyzerParams='{
  "type": "standard"
}'

standard analyzer は、次のオプションのパラメーターを受け付けます。

パラメーター	説明
stop_words	tokenization から削除される stop word のリストを含む配列です。

カスタム stop word の設定例：

Python

python

analyzer_params = {
    "type": "standard", # Specifies the standard analyzer type
    "stop_words": ["of"] # Optional: List of words to exclude from tokenization
}

Java

java

Map<String, Object> analyzerParams = new HashMap<>();
analyzerParams.put("type", "standard");
analyzerParams.put("stop_words", Collections.singletonList("of"));

Go

go

analyzerParams = map[string]any{"type": "standard", "stop_words": []string{"of"}}

Rust

rust

let analyzer_params = serde_json::json!({
    "type": "standard",
    "stop_words": ["of"]
});

C++

c++

nlohmann::json analyzer_params = {
    {"type", "standard"},
    {"stop_words", {"of"}},
};

NodeJS

javascript

analyzer_params = {
    "type": "standard", // Specifies the standard analyzer type
    "stop_words": ["of"] // Optional: List of words to exclude from tokenization
}

cURL

bash

# restful
analyzerParams='{
  "type": "standard",
  "stop_words": [
    "of"
  ]
}'

analyzer_params を定義した後、コレクションスキーマを定義する際にそれらを VARCHAR フィールドに適用できます。これにより、Zilliz Cloud は指定された analyzer を使用してそのフィールド内のテキストを処理し、効率的な tokenization と filtering を実現できます。詳細については、使用例 を参照してください。

例

analyzer 設定をコレクションスキーマに適用する前に、run_analyzer メソッドを使用してその動作を確認してください。

Analyzer 設定

Python

python

analyzer_params = {
    "type": "standard",  # Standard analyzer configuration
    "stop_words": ["for"] # Optional: Custom stop words parameter
}

Java

java

Map<String, Object> analyzerParams = new HashMap<>();
analyzerParams.put("type", "standard");
analyzerParams.put("stop_words", Collections.singletonList("for"));

Go

go

analyzerParams = map[string]any{"type": "standard", "stop_words": []string{"for"}}

Rust

rust

let analyzer_params = serde_json::json!({
    "type": "standard",
    "stop_words": ["for"]
});

C++

c++

nlohmann::json analyzer_params = {
    {"type", "standard"},
    {"stop_words", {"for"}},
};

NodeJS

javascript

// javascript
analyzer_params = {
    "type": "standard", // Specifies the standard analyzer type
    "stop_words": ["for"] // Optional: List of words to exclude from tokenization
}

cURL

bash

# restful
analyzerParams='{
  "type": "standard",
  "stop_words": [
    "for"
  ]
}'

run_analyzer を使用した検証

Python

python

from pymilvus import (
    MilvusClient,
)

client = MilvusClient(
    uri="YOUR_CLUSTER_ENDPOINT",
    token="YOUR_CLUSTER_TOKEN"
)

# Sample text to analyze
sample_text = "The Milvus vector database is built for scale!"

# Run the standard analyzer with the defined configuration
result = client.run_analyzer(sample_text, analyzer_params)
print("Standard analyzer output:", result)

Java

java

import io.milvus.v2.client.ConnectConfig;
import io.milvus.v2.client.MilvusClientV2;
import io.milvus.v2.service.vector.request.RunAnalyzerReq;
import io.milvus.v2.service.vector.response.RunAnalyzerResp;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

ConnectConfig config = ConnectConfig.builder()
        .uri("YOUR_CLUSTER_ENDPOINT")
        .token("YOUR_CLUSTER_TOKEN")
        .build();
MilvusClientV2 client = new MilvusClientV2(config);

List<String> texts = new ArrayList<>();
texts.add("The Milvus vector database is built for scale!");

RunAnalyzerResp resp = client.runAnalyzer(RunAnalyzerReq.builder()
        .texts(texts)
        .analyzerParams(analyzerParams)
        .build());
List<RunAnalyzerResp.AnalyzerResult> results = resp.getResults();

Go

go

import (
    "context"
    "encoding/json"
    "fmt"

    "github.com/milvus-io/milvus/client/v3/milvusclient"
)

client, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
    Address: "YOUR_CLUSTER_ENDPOINT",
    APIKey:  "YOUR_CLUSTER_TOKEN",
})
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

bs, _ := json.Marshal(analyzerParams)
texts := []string{"The Milvus vector database is built for scale!"}
option := milvusclient.NewRunAnalyzerOption(texts...).
    WithAnalyzerParamsStr(string(bs))

result, err := client.RunAnalyzer(ctx, option)
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

Rust

rust

use milvus::v2::error::Result;
use milvus::v2::prelude::*;

#[tokio::main]
async fn main() -> Result<()> {
    let config = ConnectConfig::new().uri("YOUR_CLUSTER_ENDPOINT").token("YOUR_CLUSTER_TOKEN");
    let client = ClientV2::new(&config).await?;

    let texts = ["The Milvus vector database is built for scale!".to_string()];
    let analyzer_params = serde_json::json!({
        "type": "standard",
        "stop_words": ["for"]
    });

    let result = client.run_analyzer(
        RunAnalyzerRequest::builder()
            .texts(texts)
            .analyzer_params(analyzer_params)
            .build()?,
    ).await?;

    println!("{:?}", result.results());
    Ok(())
}

C++

c++

#include "milvus/MilvusClientV2.h"
#include <iostream>
#include <string>

auto client = milvus::MilvusClientV2::Create();

milvus::ConnectParam connect_param{"YOUR_CLUSTER_ENDPOINT", "YOUR_CLUSTER_TOKEN"};
auto status = client->Connect(connect_param);
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}

std::string text = "The Milvus vector database is built for scale!";
auto request = milvus::RunAnalyzerRequest()
                       .AddText(text)
                       .WithAnalyzerParams(analyzer_params);

milvus::RunAnalyzerResponse response;
status = client->RunAnalyzer(request, response);
if (!status.IsOk()) {
    std::cout << status.Message() << std::endl;
}

NodeJS

javascript

// javascript
const res = await client.runAnalyzer({
    text: 'The Milvus vector database is built for scale!',
    analyzer_params: analyzer_params
});

console.log(res);

cURL

bash

# restful
curl --request POST \
  --url "${CLUSTER_ENDPOINT}/v2/vectordb/common/run_analyzer" \
  --header "Authorization: Bearer ${TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{
    "analyzerParams": "{\"type\":\"standard\",\"stop_words\":[\"for\"]}",
    "text": ["The Milvus vector database is built for scale!"]
  }'

期待される出力

sql

Standard analyzer output: ['the', 'milvus', 'vector', 'database', 'is', 'built', 'for', 'scale']