Standard Analyzer

standard analyzer は Zilliz Cloud のデフォルト analyzer であり、analyzer が指定されていない場合にテキストフィールドへ自動的に適用されます。文法ベースの tokenization を使用するため、ほとんどの言語で効果的です。

📘注意

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

Definition

standard analyzer は以下で構成されます。

• Tokenizer: standard tokenizer を使用して、文法ルールに基づきテキストを個別の単語単位に分割します。詳細は 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"));

NodeJS

javascript

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

Go

go

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

cURL

bash

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

C++

c++

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

Configuration

フィールドに 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");

NodeJS

javascript

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

Go

go

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

cURL

bash

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

C++

c++

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

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

Parameter	Description
stop_words	stop word のリストを含む配列で、tokenization から除外されます。

カスタム 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"));

NodeJS

javascript

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

Go

go

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

cURL

bash

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

C++

c++

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

analyzer_params を定義した後、collection schema を定義する際にそれらを VARCHAR フィールドへ適用できます。これにより、Zilliz Cloud は効率的な tokenization と filtering のために、指定された analyzer を使用してそのフィールド内のテキストを処理できます。詳細は Example use を参照してください。

Examples

analyzer 設定を collection schema に適用する前に、run_analyzer メソッドを使用してその動作を確認してください。

Analyzer configuration

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"));

NodeJS

javascript

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

Go

go

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

cURL

bash

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

C++

c++

nlohmann::json analyzer_params = {
    {"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;

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();

NodeJS

javascript

// javascript

Go

go

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

    "github.com/milvus-io/milvus/client/v2/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).
    WithAnalyzerParams(string(bs))

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

cURL

bash

# restful

C++

c++

#include "milvus/MilvusClientV2.h"

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;
}

Expected output

sql

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