Jieba

jieba トークナイザーは、中国語テキストを構成単語に分割して処理します。

📘Notes

jieba トークナイザーは、句読点を個別のトークンとして出力に保持します。たとえば、"你好！世界。" は ["你好", "！", "世界", "。"] となります。これらの単独の句読点トークンを除去するには、removepunct フィルターを使用してください。

設定

Milvus では、jieba トークナイザーの設定方法として、シンプル設定とカスタム設定の 2 つがサポートされています。

シンプル設定

シンプル設定では、トークナイザーを "jieba" に指定するだけです。例:

Python

python

# Simple configuration: only specifying the tokenizer name
analyzer_params = {
    "tokenizer": "jieba",  # Use the default settings: dict=["_default_"], mode="search", hmm=True
}

Java

java

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

NodeJS

javascript

const analyzer_params = {
    "tokenizer": "jieba",
};

Go

go

analyzerParams = map[string]any{"tokenizer": "jieba"}

cURL

bash

# restful
analyzerParams='{
  "tokenizer": "jieba"
}'

C++

c++

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

このシンプル設定は、以下のカスタム設定と同等です。

Python

python

# Custom configuration equivalent to the simple configuration above
analyzer_params = {
    "type": "jieba",          # Tokenizer type, fixed as "jieba"
    "dict": ["_default_"],     # Use the default dictionary
    "mode": "search",          # Use search mode for improved recall (see mode details below)
    "hmm": True                # Enable HMM for probabilistic segmentation
}

Java

java

Map<String, Object> analyzerParams = new HashMap<>();
analyzerParams.put("type", "jieba");
analyzerParams.put("dict", Collections.singletonList("_default_"));
analyzerParams.put("mode", "search");
analyzerParams.put("hmm", true);

NodeJS

javascript

// javascript

Go

go

analyzerParams = map[string]any{"type": "jieba", "dict": []any{"_default_"}, "mode": "search", "hmm": true}

cURL

bash

# restful

C++

c++

nlohmann::json analyzer_params = {
    {"tokenizer", "jieba"},
    {"dict", {"_default_"}},
    {"mode", "search"},
    {"hmm", true}
};

パラメーターの詳細については、カスタム設定 を参照してください。

カスタム設定

より詳細な制御が必要な場合は、カスタム辞書の指定、セグメンテーションモードの選択、Hidden Markov Model (HMM) の有効化・無効化を行えるカスタム設定を利用できます。例:

Python

python

# Custom configuration with user-defined settings
analyzer_params = {
    "tokenizer": {
        "type": "jieba",           # Fixed tokenizer type
        "dict": ["customDictionary"],  # Custom dictionary list; replace with your own terms
        "mode": "exact",           # Use exact mode (non-overlapping tokens)
        "hmm": False               # Disable HMM; unmatched text will be split into individual characters
    }
}

Java

java

Map<String, Object> analyzerParams = new HashMap<>();                                                                          
analyzerParams.put("tokenizer", new HashMap<String, Object>() {{
  put("type", "jieba");                                                                                                      
  put("dict", Arrays.asList("customDictionary"));             
  put("mode", "exact");
  put("hmm", false);
}});

NodeJS

javascript

// javascript

Go

go

analyzerParams := map[string]interface{}{
  "tokenizer": map[string]interface{}{
      "type": "jieba",
      "dict": []string{"customDictionary"},
      "mode": "exact",
      "hmm":  false,
  },
}

cURL

bash

# restful

C++

c++

nlohmann::json analyzerParams = {                                                                                              
  {"tokenizer", {                          
      {"type", "jieba"},                                                                                                     
      {"dict", {"customDictionary"}},                         
      {"mode", "exact"},                                                                                                     
      {"hmm", false}                                          
  }}
};

パラメーター	説明	デフォルト値
type	トークナイザーの種類です。"jieba" に固定されています。	"jieba"
dict	アナライザーが語彙ソースとして読み込む辞書のリストです。組み込みオプションは以下のとおりです。 "default": エンジンに組み込まれた簡体字中国語辞書を読み込みます。詳細は dict.txt を参照してください。 "extend_default": "default" に加え、繁体字中国語の補足辞書も読み込みます。詳細は dict.txt.big を参照してください。 組み込み辞書と任意の数のカスタム辞書を組み合わせることも可能です。例: ["default", "结巴分词器"]。	["default"]
mode	セグメンテーションモードです。指定可能な値は以下のとおりです。 "exact": 文を最も正確に分割するため、テキスト分析に適しています。 "search": exact モードを基に長い単語をさらに分割して再現率を高めるため、検索エンジンのトークン化に適しています。 詳細については、Jieba GitHub Project を参照してください。	"search"
hmm	辞書に登録されていない単語に対して Hidden Markov Model (HMM) による確率的なセグメンテーションを有効にするかどうかを示すブール値フラグです。	true

dict でインライン指定する代わりに、外部ファイルから大規模なカスタム語彙を読み込む場合は、後述の 辞書ファイルを使用したカスタム設定 を参照してください。

analyzer_params を定義した後、コレクションスキーマの定義時にそれらを VARCHAR フィールドに適用できます。これにより、Zilliz Cloud が指定されたアナライザーを使用して該当フィールドのテキストを処理し、効率的なトークン化とフィルタリングを実行できるようになります。詳細については、使用例 を参照してください。

辞書ファイルによるカスタム設定 | PRIVATE

ドメイン用語集、製品用語、固有名詞リストなど大規模なカスタム語彙がある場合は、単語をファイルに保存してリモートファイルリソースとして登録し、トークナイザーから extra_dict_file パラメーターで参照します。アナライザーは組み込み辞書に加えて、これらの単語を語彙として読み込みます。

ファイルは1行に1つの用語を記述したプレーンテキスト（UTF-8）です。例:

plaintext

结巴分词器
向量数据库

Milvus クラスターで使用するように設定されているオブジェクトストアにファイルをアップロードし、登録します。

Python

python

from pymilvus import MilvusClient

client = MilvusClient(uri="YOUR_CLUSTER_ENDPOINT")

# Register the uploaded file under a name you'll reference from analyzer configs.
client.add_file_resource(
    name="zh_terms",
    path="file/zh_terms.txt",    # full S3 object key, including the rootPath prefix
)

Java

java

// java

NodeJS

javascript

// nodejs

Go

go

// go

cURL

bash

# restful

C++

c++

// cpp

登録したリソースを、トークナイザーの extra_dict_file で参照します。

Python

python

analyzer_params = {
    "tokenizer": {
        "type": "jieba",
        "dict": ["_default_"],             # keep the built-in dictionary
        "mode": "exact",
        "hmm": False,
        "extra_dict_file": {
            "type": "remote",
            "resource_name": "zh_terms",
            "file_name": "zh_terms.txt",
        },
    },
}

client.run_analyzer(["milvus结巴分词器中文测试"], analyzer_params)
# → [['milvus', '结巴', '分词器', '中文', '测试']]

Java

java

// java

NodeJS

javascript

// nodejs

Go

go

// go

cURL

bash

# restful

C++

c++

// cpp

extra_dict_file パラメーターには、以下のフィールドを持つオブジェクトを指定します。

フィールド	説明
type	リソースの種類です。add_file_resource で登録したファイルの場合は "remote" を指定します。セルフホスト環境で使用する "local" バリアントについては、「ファイルリソースの管理」を参照してください。
resource_name	add_file_resource でファイルを登録する際に指定した名前です。
file_name	登録済みリソースのオブジェクトストアパスのうち、ファイル名部分です（例: リソースを path="file/zh_terms.txt" で登録した場合の "zh_terms.txt"）。

extra_dict_file で追加された単語は組み込み辞書とマージされ、jieba のセグメンテーションアルゴリズムによって既存のエントリと同様に処理されます。特定の用語が単独のトークンとして抽出されるかどうかは、jieba の確率重み付き DAG 選択に依存します。例えば 向量数据库 のような長いカスタム用語でも、組み込み辞書内の短いエントリの頻度が高い場合には、向量 + 数据库 に分割される可能性があります。

例

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

アナライザーの設定

Python

python

analyzer_params = {
    "tokenizer": {
        "type": "jieba",
        "dict": ["结巴分词器"],
        "mode": "exact",
        "hmm": False
    }
}

Java

java

Map<String, Object> analyzerParams = new HashMap<>();                                                                          
analyzerParams.put("tokenizer", new HashMap<String, Object>() {{
  put("type", "jieba");                                                                                                      
  put("dict", Arrays.asList("结巴分词器"));                   
  put("mode", "exact");
  put("hmm", false);
}});

NodeJS

javascript

// javascript

Go

go

analyzerParams := map[string]interface{}{
  "tokenizer": map[string]interface{}{
      "type": "jieba",
      "dict": []string{"结巴分词器"},
      "mode": "exact",
      "hmm":  false,
  },
}

cURL

bash

# restful

C++

c++

nlohmann::json analyzerParams = {
  {"tokenizer", {
      {"type", "jieba"},
      {"dict", {"结巴分词器"}},
      {"mode", "exact"},
      {"hmm", false}
  }}
};

run_analyzer を使った検証

Python

python

from pymilvus import (
    MilvusClient,
)

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

# Sample text to analyze
sample_text = "milvus结巴分词器中文测试"

# 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("milvus结巴分词器中文测试");

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{"milvus结巴分词器中文测试"}
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 = "milvus结巴分词器中文测试";
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;
}

期待される出力

python

['milvus', '结巴分词器', '中', '文', '测', '试']