[説明] このページは機械翻訳された日本語版です。内容に誤りがございましたら、報告していただけると助かります。

Cohere

このトピックでは、Milvus で Cohere 埋め込み関数を設定および使用する方法について説明します。

モデルの選択

Milvus は Cohere が提供する埋め込みモデルをサポートしています。以下は現在利用可能な埋め込みモデルの一覧です（参考用）：

Model Name	Dimensions	Max Tokens	Description
embed-english-v3.0	1,024	512	A model that allows for text to be classified or turned into embeddings. English only.
embed-multilingual-v3.0	1,024	512	Provides multilingual classification and embedding support. See supported languages here.
embed-english-light-v3.0	384	512	A smaller, faster version of embed-english-v3.0. Almost as capable, but a lot faster. English only.
embed-multilingual-light-v3.0	384	512	A smaller, faster version of embed-multilingual-v3.0. Almost as capable, but a lot faster. Supports multiple languages.
embed-english-v2.0	4,096	512	Older embeddings model that allows for text to be classified or turned into embeddings. English only.
embed-english-light-v2.0	1,024	512	A smaller, faster version of embed-english-v2.0. Almost as capable, but a lot faster. English only.
embed-multilingual-v2.0	768	256	Provides multilingual classification and embedding support. See supported languages here.

詳細については、Cohere's Embed Models を参照してください。

事前準備

テキスト埋め込み関数を使用する前に、以下の前提条件を満たしていることを確認してください。

• 埋め込みモデルを選択

  使用する埋め込みモデルを決定してください。この選択により、埋め込みの動作と出力形式が決まります。詳細については、埋め込みモデルを選択 を参照してください。

• Cohere と連携し、統合IDを取得

  Cohere が提供する埋め込みモデルを使用するには、事前に Cohere とのモデルプロバイダー連携を作成し、統合IDを取得する必要があります。詳細については、モデルプロバイダーとの連携 を参照してください。

• 互換性のあるコレクションスキーマを設計

  コレクションスキーマに以下のフィールドを含めるように計画してください：

  • 生の入力テキストを格納するテキストフィールド（VARCHAR）

  • 選択した埋め込みモデルの出力と一致するデータ型および次元数を持つ密ベクトルフィールド

• 挿入時および検索時に生テキストを扱う準備をする

  テキスト埋め込み関数を有効にすると、生テキストを直接挿入およびクエリできます。埋め込みはシステムによって自動的に生成されます。

ステップ 1: テキスト埋め込み関数付きのコレクションを作成

スキーマフィールドの定義

埋め込み関数を使用するには、特定のスキーマでコレクションを作成する必要があります。このスキーマには、少なくとも以下の3つの必須フィールドを含める必要があります：

• コレクション内の各エンティティを一意に識別する主キーとなるフィールド

• 埋め込み対象の生データを格納する VARCHAR フィールド

• テキスト埋め込み関数が VARCHAR フィールドに対して生成する密ベクトル埋め込みを格納するためのベクトルフィールド

次の例では、テキストデータを格納するスカラー フィールド "document" と、Function モジュールによって生成される埋め込みを格納するベクトル フィールド "dense" を持つスキーマを定義しています。ベクトルの次元数（dim）を、選択した埋め込みモデルの出力に合わせて設定することを忘れないでください。

Python

from pymilvus import MilvusClient, DataType, Function, FunctionType

# Initialize Milvus client
client = MilvusClient(
    uri="YOUR_CLUSTER_ENDPOINT",
    token="YOUR_CLUSTER_TOKEN"
)

# Create a new schema for the collection
schema = client.create_schema()

# Add primary field "id"
schema.add_field("id", DataType.INT64, is_primary=True, auto_id=False)

# Add scalar field "document" for storing textual data
schema.add_field("document", DataType.VARCHAR, max_length=9000)

# Add vector field "dense" for storing embeddings.
# IMPORTANT: Set dim to match the exact output dimension of the embedding model.
schema.add_field("dense", DataType.FLOAT_VECTOR, dim=1024)

Java

import io.milvus.v2.common.DataType;
import io.milvus.v2.client.ConnectConfig;
import io.milvus.v2.client.MilvusClientV2;
import io.milvus.v2.service.collection.request.AddFieldReq;
import io.milvus.v2.service.collection.request.CreateCollectionReq;

String CLUSTER_ENDPOINT = "YOUR_CLUSTER_ENDPOINT";
String TOKEN = "YOUR_CLUSTER_TOKEN";

ConnectConfig connectConfig = ConnectConfig.builder()
        .uri(CLUSTER_ENDPOINT)
        .token(TOKEN)
        .build();

MilvusClientV2 client = new MilvusClientV2(connectConfig);

CreateCollectionReq.CollectionSchema schema = client.createSchema();

schema.addField(AddFieldReq.builder()
        .fieldName("id")
        .dataType(DataType.Int64)
        .isPrimaryKey(true)
        .autoID(false)
        .build());

schema.addField(AddFieldReq.builder()
        .fieldName("document")
        .dataType(DataType.VarChar)
        .maxLength(9000)
        .build());
        
schema.addField(AddFieldReq.builder()
        .fieldName("dense")
        .dataType(DataType.FloatVector)
        .dimension(1024)
        .build());

NodeJS

// nodejs

Go

// go

cURL

# restful

テキスト埋め込み関数の定義

Milvus の Function モジュールは、スカラー フィールドに格納された生データを自動的に埋め込みベクトルに変換し、明示的に定義されたベクトル フィールドに格納します。

以下の例では、スカラー フィールド "document" を埋め込みベクトルに変換する Function モジュール（cohere_func）を追加し、結果として得られるベクトルを前述の "dense" ベクトル フィールドに格納しています。

埋め込み関数を定義したら、それをコレクション スキーマに追加します。これにより、Milvus は指定された埋め込み関数を使用してテキスト データから埋め込みを処理・保存するよう指示されます。

Python

# Define embedding function specifically for embedding model provider
text_embedding_function = Function(
    name="cohere_func",                                 # Unique identifier for this embedding function
    function_type=FunctionType.TEXTEMBEDDING,           # Indicates a text embedding function
    input_field_names=["document"],                     # Scalar field(s) containing text data to embed
    output_field_names=["dense"],                       # Vector field(s) for storing embeddings
    params={                                            # Provider-specific embedding parameters (function-level)
        "provider": "cohere",                           # Must be set to "cohere"
        "model_name": "embed-english-v3.0",             # Specifies the embedding model to use

        "integration_id": "YOUR_INTEGRATION_ID",    # Integration ID generated in the Zilliz Cloud console for the selected model provider

        # "url": "https://api.cohere.com/v2/embed",     # Defaults to the official endpoint if omitted
        # "truncate": "NONE",                           # Specifies how the API will handle inputs longer than the maximum token length.
    }
)

# Add the configured embedding function to your existing collection schema
schema.add_function(text_embedding_function)

Java

import io.milvus.v2.service.collection.request.CreateCollectionReq.Function;

Function function = Function.builder()
        .functionType(FunctionType.TEXTEMBEDDING)
        .name("cohere_func")
        .inputFieldNames(Collections.singletonList("document"))
        .outputFieldNames(Collections.singletonList("dense"))
        .param("provider", "cohere")
        .param("model_name", "embed-english-v3.0")

        .param("integration_id", "YOUR_INTEGRATION_ID")

        .build();
schema.addFunction(function);

NodeJS

// nodejs

Go

// go

cURL

# restful

インデックスの設定

必要なフィールドとビルトイン関数を使用してスキーマを定義した後、コレクション用のインデックスを設定します。このプロセスを簡略化するために、index_type として AUTOINDEX を使用してください。このオプションにより、Zilliz Cloud がデータの構造に基づいて最も適切なインデックスタイプを自動的に選択・設定します。

Python

# Prepare index parameters
index_params = client.prepare_index_params()

# Add AUTOINDEX to automatically select optimal indexing method
index_params.add_index(
    field_name="dense",
    index_type="AUTOINDEX",
    metric_type="COSINE" 
)

Java

import io.milvus.v2.common.IndexParam;

List<IndexParam> indexes = new ArrayList<>();
indexes.add(IndexParam.builder()
        .fieldName("dense")
        .indexType(IndexParam.IndexType.AUTOINDEX)
        .metricType(IndexParam.MetricType.COSINE)
        .build());

NodeJS

// nodejs

Go

// go

cURL

# restful

コレクションの作成

定義済みのスキーマとインデックスパラメータを使用して、コレクションを作成します。

Python

# Create collection named "demo"
client.create_collection(
    collection_name='demo', 
    schema=schema, 
    index_params=index_params
)

Java

import io.milvus.v2.service.collection.request.CreateCollectionReq;

CreateCollectionReq requestCreate = CreateCollectionReq.builder()
        .collectionName("demo")
        .collectionSchema(schema)
        .indexParams(indexes)
        .build();
client.createCollection(requestCreate);

NodeJS

// nodejs

Go

// go

cURL

# restful

ステップ 2: データの挿入

コレクションとインデックスの設定が完了したら、生データを挿入できます。このプロセスでは、生のテキストを提供するだけで済みます。先ほど定義した Function モジュールが、各テキストエントリに対応するスパースベクトルを自動的に生成します。

Python

# Insert sample documents
client.insert('demo', [
    {'id': 1, 'document': 'Milvus simplifies semantic search through embeddings.'},
    {'id': 2, 'document': 'Vector embeddings convert text into searchable numeric data.'},
    {'id': 3, 'document': 'Semantic search helps users find relevant information quickly.'},
])

Java

import com.google.gson.Gson;
import com.google.gson.JsonObject;
import io.milvus.v2.service.vector.request.InsertReq;

Gson gson = new Gson();
List<JsonObject> rows = Arrays.asList(
        gson.fromJson("{\"id\": 0, \"document\": \"Milvus simplifies semantic search through embeddings.\"}", JsonObject.class),
        gson.fromJson("{\"id\": 1, \"document\": \"Vector embeddings convert text into searchable numeric data.\"}", JsonObject.class),
        gson.fromJson("{\"id\": 2, \"document\": \"Semantic search helps users find relevant information quickly.\"}", JsonObject.class),
);

client.insert(InsertReq.builder()
        .collectionName("demo")
        .data(rows)
        .build());

NodeJS

// nodejs

Go

// go

cURL

# restful

Step 3: Search with text

データの挿入後、生のクエリテキストを使用してセマンティック検索を実行します。Milvusは自動的にクエリを埋め込みベクトルに変換し、類似性に基づいて関連ドキュメントを取得し、最も一致する結果を返します。

Python

# Perform semantic search
results = client.search(
    collection_name='demo', 
    data=['How does Milvus handle semantic search?'], # Use text query rather than query vector
    anns_field='dense',   # Use the vector field that stores embeddings
    limit=1,
    output_fields=['document'],
)

print(results)

Java

import io.milvus.v2.service.vector.request.SearchReq;
import io.milvus.v2.service.vector.request.data.EmbeddedText;
import io.milvus.v2.service.vector.response.SearchResp;

SearchResp searchResp = client.search(SearchReq.builder()
        .collectionName("demo")
        .data(Collections.singletonList(new EmbeddedText("How does Milvus handle semantic search?")))
        .limit(1)
        .outputFields(Collections.singletonList("document"))
        .build());
List<List<SearchResp.SearchResult>> searchResults = searchResp.getSearchResults();
for (List<SearchResp.SearchResult> results : searchResults) {
    for (SearchResp.SearchResult result : results) {
        System.out.println(result);
    }
}

NodeJS

// nodejs

Go

// go

cURL

# restful