スキーマの解説

スキーマはコレクションのデータ構造を定義します。コレクションを作成する前に、そのスキーマ設計を固める必要があります。このページでは、コレクションスキーマを理解し、サンプルスキーマを自分で設計できるようにします。

概要

Zilliz Cloud では、コレクションスキーマはリレーショナルデータベースのテーブルに相当し、Zilliz Cloud がコレクション内のデータをどのように整理するかを定義します。

適切に設計されたスキーマは、データモデルを抽象化し、検索を通じてビジネス目標を達成できるかどうかを左右するため、不可欠です。さらに、コレクションに挿入されるすべてのデータ行はスキーマに従う必要があるため、データの一貫性と長期的な品質の維持にも役立ちます。技術的な観点では、明確に定義されたスキーマは、整理された列データストレージとよりクリーンなインデックス構造につながり、検索パフォーマンスを向上させます。

コレクションスキーマには、プライマリキー、少なくとも 1 つのベクトルフィールド、および複数のスカラーフィールドがあります。次の図は、記事をスキーマフィールドの一覧にマッピングする方法を示しています。

検索システムのデータモデル設計では、ビジネス要件を分析し、情報をスキーマで表現されるデータモデルへ抽象化します。たとえば、あるテキストを検索するには、リテラル文字列を「embedding」によってベクトルに変換し、ベクトル検索を有効にすることで「インデックス化」する必要があります。この必須要件に加えて、公開タイムスタンプや著者などの他のプロパティを保存する必要がある場合もあります。このメタデータにより、フィルタリングを通じてセマンティック検索を絞り込み、特定の日付以降に公開されたテキストや、特定の著者によるテキストのみを返すことができます。また、検索結果をアプリケーションで表示するために、メインテキストとともにこれらのスカラーを取得することもできます。これらのテキスト片を整理するには、それぞれに一意の識別子を割り当てる必要があり、これは整数または文字列で表現されます。これらの要素は、高度な検索ロジックを実現するうえで不可欠です。

適切に設計されたスキーマの作成方法については、スキーマ設計のハンズオン を参照してください。

スキーマの作成

次のコードスニペットは、スキーマの作成方法を示しています。

Python

python

from pymilvus import MilvusClient, DataType

schema = MilvusClient.create_schema()

Java

java

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

CreateCollectionReq.CollectionSchema schema = client.createSchema();

NodeJS

javascript

import { MilvusClient, DataType } from "@zilliz/milvus2-sdk-node";

const schema = []

Go

go

import "github.com/milvus-io/milvus/client/v2/entity"

schema := entity.NewSchema()

cURL

bash

export schema='{
    "fields": []
}'

C++

c++

#include "milvus/MilvusClientV2.h"

milvus::CollectionSchemaPtr schema = std::make_shared<milvus::CollectionSchema>();

プライマリフィールドの追加

コレクション内のプライマリフィールドは、エンティティを一意に識別します。受け付ける値は Int64 または VarChar のみです。次のコードスニペットは、プライマリフィールドの追加方法を示しています。

Python

python

schema.add_field(
    field_name="my_id",
    datatype=DataType.INT64,
    is_primary=True,
    auto_id=False,
)

Java

java

import io.milvus.v2.common.DataType;
import io.milvus.v2.service.collection.request.AddFieldReq; 

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

NodeJS

javascript

schema.push({
    name: "my_id",
    data_type: DataType.Int64,
    is_primary_key: true,
    autoID: false
});

Go

go

schema.WithField(entity.NewField().WithName("my_id").
    WithDataType(entity.FieldTypeInt64).
    WithIsPrimaryKey(true).
    WithIsAutoID(false),
)

cURL

bash

export primaryField='{
    "fieldName": "my_id",
    "dataType": "Int64",
    "isPrimary": true
}'

export schema='{
    \"autoID\": false,
    \"fields\": [
        $primaryField
    ]
}'

C++

c++

schema->AddField(milvus::FieldSchema("my_id", milvus::DataType::INT64, "", true, false));

フィールドを追加する際に、その is_primary プロパティを True に設定することで、そのフィールドをプライマリフィールドとして明示的に指定できます。プライマリフィールドは、デフォルトで Int64 値を受け付けます。この場合、プライマリフィールドの値は 12345 のような整数である必要があります。プライマリフィールドで VarChar 値を使用する場合、値は my_entity_1234 のような文字列である必要があります。

また、autoId プロパティを True に設定すると、データ挿入時に Zilliz Cloud がプライマリフィールドの値を自動的に割り当てるようにできます。

Notes

プライマリキーを手動で設定することが有利な場合を除き、すべてのケースで autoId に依存することをお勧めします。

詳細については、プライマリフィールドと AutoID を参照してください。

ベクトルフィールドの追加

ベクトルフィールドは、さまざまなスパースおよび高密度のベクトル埋め込みを受け付けます。Zilliz Cloud では、1 つのコレクションに 4 つのベクトルフィールドを追加できます。次のコードスニペットは、ベクトルフィールドの追加方法を示しています。

Python

python

schema.add_field(
    field_name="my_vector",
    datatype=DataType.FLOAT_VECTOR,
    dim=5
)

Java

java

schema.addField(AddFieldReq.builder()
        .fieldName("my_vector")
        .dataType(DataType.FloatVector)
        .dimension(5)
        .build());

NodeJS

javascript

schema.push({
    name: "my_vector",
    data_type: DataType.FloatVector,
    dim: 5
});

Go

go

schema.WithField(entity.NewField().WithName("my_vector").
    WithDataType(entity.FieldTypeFloatVector).
    WithDim(5),
)

cURL

bash

export vectorField='{
    "fieldName": "my_vector",
    "dataType": "FloatVector",
    "elementTypeParams": {
        "dim": 5
    }
}'

export schema="{
    \"autoID\": false,
    \"fields\": [
        $primaryField,
        $vectorField
    ]
}"

C++

c++

schema->AddField(milvus::FieldSchema("my_vector", milvus::DataType::FLOAT_VECTOR).WithDimension(5));

上記のコードスニペットの dim パラメーターは、ベクトルフィールドに格納されるベクトル埋め込みの次元数を示します。FLOAT_VECTOR 値は、そのベクトルフィールドが 32 ビットの浮動小数点数のリストを保持することを示しており、これらは通常、アンチログの表現に使用されます。これに加えて、Zilliz Cloud は次の種類のベクトル埋め込みもサポートしています。

• FLOAT16_VECTOR

  この型のベクトルフィールドは、16 ビットの半精度浮動小数点数のリストを保持し、通常はメモリや帯域幅が制限されたディープラーニングまたは GPU ベースの計算シナリオに適用されます。

• BFLOAT16_VECTOR

  この型のベクトルフィールドは、精度は低下していますが Float32 と同じ指数範囲を持つ 16 ビット浮動小数点数のリストを保持します。このタイプのデータは、精度に大きな影響を与えずにメモリ使用量を削減できるため、ディープラーニングのシナリオで一般に使用されます。

• INT8_VECTOR

  この型のベクトルフィールドは、8 ビットの符号付き整数（int8）で構成されるベクトルを格納し、各要素の範囲は –128 から 127 です。ResNet や EfficientNet などの量子化ディープラーニングアーキテクチャ向けに設計されており、精度の低下を最小限に抑えながら、モデルサイズを大幅に縮小し、推論速度を向上させます。Note: このベクトル型は HNSW インデックスでのみサポートされます。

• BINARY_VECTOR

  この型のベクトルフィールドは、0 と 1 のリストを保持します。これらは、画像処理や情報検索のシナリオでデータを表現するためのコンパクトな特徴量として機能します。

• SPARSE_FLOAT_VECTOR

  この型のベクトルフィールドは、非ゼロの数値とそのシーケンス番号のリストを保持し、スパースなベクトル埋め込みを表現します。

スカラーフィールドの追加

一般的なケースでは、スカラーフィールドを使用して Zilliz Cloud クラスターに格納されたベクトル埋め込みのメタデータを保存し、メタデータフィルタリングを伴う ANN 検索を実行して検索結果の正確性を向上させることができます。Zilliz Cloud は、VarChar、TEXT、Boolean、Int、Float、Double など、複数のスカラーフィールド型をサポートしています。

VarChar フィールドの追加

Zilliz Cloud クラスターでは、VarChar フィールドを使用して文字列を格納できます。VarChar フィールドの詳細については、文字列フィールド を参照してください。

Python

python

schema.add_field(
    field_name="my_varchar",
    datatype=DataType.VARCHAR,
    max_length=512
)

Java

java

schema.addField(AddFieldReq.builder()
        .fieldName("my_varchar")
        .dataType(DataType.VarChar)
        .maxLength(512)
        .build());

NodeJS

javascript

schema.push({
    name: "my_varchar",
    data_type: DataType.VarChar,
    max_length: 512
});

Go

go

schema.WithField(entity.NewField().WithName("my_varchar").
    WithDataType(entity.FieldTypeVarChar).
    WithMaxLength(512),
)

cURL

bash

export varCharField='{
    "fieldName": "my_varchar",
    "dataType": "VarChar",
    "elementTypeParams": {
        "max_length": 512
    }
}'

export schema="{
    \"autoID\": false,
    \"fields\": [
        $primaryField,
        $vectorField,
        $varCharField
    ]
}"

C++

c++

schema->AddField(milvus::FieldSchema("my_varchar", milvus::DataType::VARCHAR).WithMaxLength(512));

TEXT フィールドの追加

Milvus 3.0 以降では、TEXT フィールドを使用して、ドキュメントテキスト、パッセージ、ログ、その他の長文コンテンツを格納できます。VARCHAR とは異なり、TEXT フィールドには max_length は不要です。TEXT フィールドの詳細については、TEXT フィールド を参照してください。

Python

python

schema.add_field(
    field_name="my_text",
    datatype=DataType.TEXT,
)

Java

java

// java

NodeJS

javascript

// nodejs

Go

go

// go

cURL

bash

# restful

数値フィールドの追加

Zilliz Cloud がサポートする数値型は、Int8、Int16、Int32、Int64、Float、Double です。数値フィールドの詳細については、数値フィールド を参照してください。

Python

python

schema.add_field(
    field_name="my_int64",
    datatype=DataType.INT64,
)

Java

java

schema.addField(AddFieldReq.builder()
        .fieldName("my_int64")
        .dataType(DataType.Int64)
        .build());

NodeJS

javascript

schema.push({
    name: "my_int64",
    data_type: DataType.Int64,
});

Go

go

schema.WithField(entity.NewField().WithName("my_int64").
    WithDataType(entity.FieldTypeInt64),
)

cURL

bash

export int64Field='{
    "fieldName": "my_int64",
    "dataType": "Int64"
}'

export schema="{
    \"autoID\": false,
    \"fields\": [
        $primaryField,
        $vectorField,
        $varCharField,
        $int64Field
    ]
}"

C++

c++

schema->AddField(milvus::FieldSchema("my_int64", milvus::DataType::INT64));

ブール値フィールドの追加

Zilliz Cloud はブール値フィールドをサポートしています。次のコードスニペットは、ブール値フィールドの追加方法を示しています。

Python

python

schema.add_field(
    field_name="my_bool",
    datatype=DataType.BOOL,
)

Java

java

schema.addField(AddFieldReq.builder()
        .fieldName("my_bool")
        .dataType(DataType.Bool)
        .build());

NodeJS

javascript

schema.push({
    name: "my_bool",
    data_type: DataType.Boolean,
});

Go

go

schema.WithField(entity.NewField().WithName("my_bool").
    WithDataType(entity.FieldTypeBool),
)

cURL

bash

export boolField='{
    "fieldName": "my_bool",
    "dataType": "Boolean"
}'

export schema="{
    \"autoID\": false,
    \"fields\": [
        $primaryField,
        $vectorField,
        $varCharField,
        $int64Field,
        $boolField
    ]
}"

C++

c++

schema->AddField(milvus::FieldSchema("my_bool", milvus::DataType::BOOL));

複合フィールドの追加

Zilliz Cloud では、複合フィールドとは、JSON フィールドのキーや Array フィールドのインデックスなど、より小さなサブフィールドに分割できるフィールドです。

JSON フィールドの追加

JSON フィールドは通常、半構造化された JSON データを格納します。JSON フィールドの詳細については、JSON フィールドの概要 を参照してください。

Python

python

schema.add_field(
    field_name="my_json",
    datatype=DataType.JSON,
)

Java

java

schema.addField(AddFieldReq.builder()
        .fieldName("my_json")
        .dataType(DataType.JSON)
        .build());

NodeJS

javascript

schema.push({
    name: "my_json",
    data_type: DataType.JSON,
});

Go

go

schema.WithField(entity.NewField().WithName("my_json").
    WithDataType(entity.FieldTypeJSON),
)

cURL

bash

export jsonField='{
    "fieldName": "my_json",
    "dataType": "JSON"
}'

export schema="{
    \"autoID\": false,
    \"fields\": [
        $primaryField,
        $vectorField,
        $varCharField,
        $int64Field,
        $boolField,
        $jsonField
    ]
}"

C++

c++

schema->AddField(milvus::FieldSchema("my_json", milvus::DataType::JSON));

Array フィールドの追加

Array フィールドは要素のリストを格納します。Array フィールド内のすべての要素は同じデータ型である必要があります。Array フィールドの詳細については、Array フィールド を参照してください。

Python

python

schema.add_field(
    field_name="my_array",
    datatype=DataType.ARRAY,
    element_type=DataType.VARCHAR,
    max_capacity=5,
    max_length=512,
)

Java

java

schema.addField(AddFieldReq.builder()
        .fieldName("my_array")
        .dataType(DataType.Array)
        .elementType(DataType.VarChar)
        .maxCapacity(5)
        .maxLength(512)
        .build());

NodeJS

javascript

schema.push({
    name: "my_array",
    data_type: DataType.Array,
    element_type: DataType.VarChar,
    max_capacity: 5,
    max_length: 512
});

Go

go

schema.WithField(entity.NewField().WithName("my_array").
    WithDataType(entity.FieldTypeArray).
    WithElementType(entity.FieldTypeInt64).
    WithMaxLength(512).
    WithMaxCapacity(5),
)

cURL

bash

export arrayField='{
    "fieldName": "my_array",
    "dataType": "Array",
    "elementDataType": "VarChar",
    "elementTypeParams": {
        "max_length": 512
    }
}'

export schema="{
    \"autoID\": false,
    \"fields\": [
        $primaryField,
        $vectorField,
        $varCharField,
        $int64Field,
        $boolField,
        $jsonField,
        $arrayField
    ]
}"

C++

c++

schema->AddField(milvus::FieldSchema("my_array", milvus::DataType::ARRAY)
                                    .WithElementType(milvus::DataType::VARCHAR)
                                    .WithMaxCapacity(5)
                                    .WithMaxLength(512));