メインコンテンツまでスキップ
バージョン: User Guides (Cloud)

OpenAI

Zilliz Cloud で OpenAI の埋め込みモデルを使用するには、埋め込みモデルを選択し、テキスト埋め込み関数付きのコレクションを作成します。

モデルの選択肢​

Zilliz Cloud は、OpenAI が提供するすべての埋め込みモデルをサポートしています。以下は、参照用に整理した利用可能な OpenAI 埋め込みモデルの一覧です：

モデル名

次元数

最大トークン数

説明

text-embedding-3-small

デフォルト: 1,536（1,536未満の次元数に短縮可能）

8,191

コスト感度の高いスケーラブルなセマンティック検索に最適で、低価格で強力なパフォーマンスを提供します。

text-embedding-3-large

デフォルト: 3,072（3,072未満の次元数に短縮可能）

8,191

より高い検索精度と豊かなセマンティック表現を必要とするアプリケーションに最適です。

text-embedding-ada-002

固定: 1,536（短縮不可）

8,191

レガシーパイプラインや下位互換性が必要なシナリオ向けの前世代モデルです。

第3世代の埋め込みモデル（text-embedding-3）は、dim パラメータを使用して埋め込みのサイズを小さくできます。通常、より大きな埋め込みは計算・メモリ・ストレージの観点から高コストになります。次元数を調整できることで、全体的なコストとパフォーマンスをより細かく制御できます。各モデルの詳細については、Embedding models および OpenAI announcement blog post を参照してください。

事前準備​

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

  • 埋め込みモデルを選択

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

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

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

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

    コレクションスキーマには以下のフィールドを含める必要があります：

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

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

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

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

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

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

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

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

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

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

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

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.
# For instance, OpenAI's text-embedding-3-small model outputs 1536-dimensional vectors.
# For dense vector, data type can be FLOAT_VECTOR or INT8_VECTOR
schema.add_field("dense", DataType.FLOAT_VECTOR, dim=1536)

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

テキスト埋め込み関数は、VARCHARフィールドに格納された生データを自動的に埋め込みに変換し、明示的に定義されたベクトルフィールドに格納します。

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

# Define embedding function (example: OpenAI provider)
text_embedding_function = Function(
    name="openai_embedding",                  # Unique identifier for this embedding function
    function_type=FunctionType.TEXTEMBEDDING, # Type of embedding function
    input_field_names=["document"],           # Scalar field to embed
    output_field_names=["dense"],             # Vector field to store embeddings
    params={                                  # Provider-specific configuration (highest priority)
        "provider": "openai",                 # Embedding model provider
        "model_name": "text-embedding-3-small",     # Embedding model

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

        # "dim": "1536",       # Optional: shorten the vector dimension
        # "user": "user123"    # Optional: identifier for API tracking
    }
)

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

インデックスの設定​

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

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

コレクションの作成​

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

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

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

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

# 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.'},
])

Step 3: Search with text​

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

# 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)

検索およびクエリ操作の詳細については、基本的なベクトル検索 および クエリ を参照してください。